Contents

# frozen_string_literal: true

# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
# 
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# 
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.

module Protocol
	module Redis
		module Methods
			module Connection
				# Authenticate to the server.
				# @see https://redis.io/commands/auth
				# @param username [String] Optional username, if Redis ACLs are used.
				# @param password [String] Required password.
				def auth(*arguments)
					call("AUTH", *arguments)
				end
				
				# Echo the given string.
				# @see https://redis.io/commands/echo
				# @param message [String]
				def echo(message)
					call("ECHO", message)
				end
				
				# Ping the server.
				# @see https://redis.io/commands/ping
				# @param message [String]
				def ping(message)
					call("PING", message)
				end
				
				# Close the connection.
				# @see https://redis.io/commands/quit
				def quit
					call("QUIT")
				end
			end
		end
	end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
protocol-redis-0.6.1	lib/protocol/redis/methods/connection.rb