Class: Aerospike::ClientPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/aerospike/policy/client_policy.rb

Overview

Container object for client policy command.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opt = {}) ⇒ ClientPolicy

Returns a new instance of ClientPolicy.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/aerospike/policy/client_policy.rb', line 25

def initialize(opt={})
  # Initial host connection timeout in seconds. The timeout when opening a connection
  # to the server host for the first time.
  @timeout = opt[:timeout] || 1.0 # 1 second

  # Size of the Connection Queue cache.
  @connection_queue_size = opt[:connection_queue_size] || 64

  # Throw exception if host connection fails during add_host.
  @fail_if_not_connected = opt.has_key?(:fail_if_not_connected) ? opt[:fail_if_not_connected] : true

  # Tend interval in milliseconds; determines the interval at
  # which the client checks for cluster state changes. Minimum interval is 10ms.
  self.tend_interval = opt[:tend_interval] || 1000 # 1 second

  # user name
  @user = opt[:user]

  # password
  @password = opt[:password]

  # Cluster Name
  @cluster_name = opt[:cluster_name]
end

Instance Attribute Details

#cluster_nameObject

Returns the value of attribute cluster_name.



23
24
25
# File 'lib/aerospike/policy/client_policy.rb', line 23

def cluster_name
  @cluster_name
end

#connection_queue_sizeObject

Returns the value of attribute connection_queue_size.



22
23
24
# File 'lib/aerospike/policy/client_policy.rb', line 22

def connection_queue_size
  @connection_queue_size
end

#fail_if_not_connectedObject

Returns the value of attribute fail_if_not_connected.



22
23
24
# File 'lib/aerospike/policy/client_policy.rb', line 22

def fail_if_not_connected
  @fail_if_not_connected
end

#passwordObject

Returns the value of attribute password.



21
22
23
# File 'lib/aerospike/policy/client_policy.rb', line 21

def password
  @password
end

#tend_intervalObject

Returns the value of attribute tend_interval.



22
23
24
# File 'lib/aerospike/policy/client_policy.rb', line 22

def tend_interval
  @tend_interval
end

#timeoutObject

Returns the value of attribute timeout.



22
23
24
# File 'lib/aerospike/policy/client_policy.rb', line 22

def timeout
  @timeout
end

#userObject

Returns the value of attribute user.



21
22
23
# File 'lib/aerospike/policy/client_policy.rb', line 21

def user
  @user
end

Instance Method Details

#requires_authenticationObject



50
51
52
# File 'lib/aerospike/policy/client_policy.rb', line 50

def requires_authentication
  (@user && @user != '') || (@password && @password != '')
end