Class: MemCache::Server

Inherits:
Object
  • Object
show all
Defined in:
lib/memcache.rb

Overview

This class represents a memcached server instance.

Constant Summary collapse

RETRY_DELAY =

The amount of time to wait before attempting to re-establish a connection with a server that is marked dead.

30.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(memcache, host, port = DEFAULT_PORT, weight = DEFAULT_WEIGHT) ⇒ Server

Create a new MemCache::Server object for the memcached instance listening on the given host and port, weighted by the given weight.

Raises:

  • (ArgumentError) 


969
970
971
972
973
974
975
976
977
978
979
980
981
982
 
# File 'lib/memcache.rb', line 969

def initialize(memcache, host, port = DEFAULT_PORT, weight = DEFAULT_WEIGHT)
  raise ArgumentError, "No host specified" if host.nil? or host.empty?
  raise ArgumentError, "No port specified" if port.nil? or port.to_i.zero?

  @host   = host
  @port   = port.to_i
  @weight = weight.to_i

  @sock   = nil
  @retry  = nil
  @status = 'NOT CONNECTED'
  @timeout = memcache.timeout
  @logger = memcache.logger
end

Instance Attribute Details

#host ⇒ Object (readonly)

The host the memcached server is running on.



941
942
943
 
# File 'lib/memcache.rb', line 941

def host
  @host
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



963
964
965
 
# File 'lib/memcache.rb', line 963

def logger
  @logger
end

#port ⇒ Object (readonly)

The port the memcached server is listening on.



946
947
948
 
# File 'lib/memcache.rb', line 946

def port
  @port
end

#retry ⇒ Object (readonly)

The time of next retry if the connection is dead.



956
957
958
 
# File 'lib/memcache.rb', line 956

def retry
  @retry
end

#status ⇒ Object (readonly)

A text status string describing the state of the server.



961
962
963
 
# File 'lib/memcache.rb', line 961

def status
  @status
end

#weight ⇒ Object (readonly)

The weight given to the server.



951
952
953
 
# File 'lib/memcache.rb', line 951

def weight
  @weight
end

Instance Method Details

#alive? ⇒ Boolean

Check whether the server connection is alive. This will cause the socket to attempt to connect if it isn’t already connected and or if the server was previously marked as down and the retry time has been exceeded.

Returns:

  • (Boolean) 


997
998
999
 
# File 'lib/memcache.rb', line 997

def alive?
  !!socket
end

#close ⇒ Object

Close the connection to the memcached server targeted by this object. The server is not considered dead.



1037
1038
1039
1040
1041
1042
 
# File 'lib/memcache.rb', line 1037

def close
  @sock.close if @sock && !@sock.closed?
  @sock   = nil
  @retry  = nil
  @status = "NOT CONNECTED"
end

#connect_to(host, port, timeout = nil) ⇒ Object 



1027
1028
1029
1030
1031
 
# File 'lib/memcache.rb', line 1027

def connect_to(host, port, timeout=nil)
  io = MemCache::BufferedIO.new(TCPSocket.new(host, port))
  io.read_timeout = timeout
  io
end

#inspect ⇒ Object

Return a string representation of the server object.



987
988
989
 
# File 'lib/memcache.rb', line 987

def inspect
  "<MemCache::Server: %s:%d [%d] (%s)>" % [@host, @port, @weight, @status]
end

#mark_dead(error) ⇒ Object

Mark the server as dead and close its socket.



1047
1048
1049
1050
1051
1052
1053
1054
1055
 
# File 'lib/memcache.rb', line 1047

def mark_dead(error)
  @sock.close if @sock && !@sock.closed?
  @sock   = nil
  @retry  = Time.now + RETRY_DELAY

  reason = "#{error.class.name}: #{error.message}"
  @status = sprintf "%s:%s DEAD (%s), will retry at %s", @host, @port, reason, @retry
  @logger.info { @status } if @logger
end

#socket ⇒ Object

Try to connect to the memcached server targeted by this object. Returns the connected socket object on success or nil on failure.



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/memcache.rb', line 1005

def socket
  return @sock if @sock and not @sock.closed?

  @sock = nil

  # If the host was dead, don't retry for a while.
  return if @retry and @retry > Time.now

  # Attempt to connect if not already connected.
  begin
    @sock = connect_to(@host, @port, @timeout)
    @sock.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
    @retry  = nil
    @status = 'CONNECTED'
  rescue SocketError, SystemCallError, IOError => err
    logger.warn { "Unable to open socket: #{err.class.name}, #{err.message}" } if logger
    mark_dead err
  end

  return @sock
end