Class: Async::Redis::Client

Inherits:
Object
  • Object
show all
Includes:
Protocol::Redis::Methods
Defined in:
lib/async/redis/client.rb

Direct Known Subclasses

SentinelsClient

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint = Redis.local_endpoint, protocol: Protocol::RESP2, **options) ⇒ Client

Returns a new instance of Client.



47
48
49
50
51
52
 
# File 'lib/async/redis/client.rb', line 47

def initialize(endpoint = Redis.local_endpoint, protocol: Protocol::RESP2, **options)
  @endpoint = endpoint
  @protocol = protocol
  
  @pool = connect(**options)
end

Instance Attribute Details

#endpoint ⇒ Object (readonly)

Returns the value of attribute endpoint.



54
55
56
 
# File 'lib/async/redis/client.rb', line 54

def endpoint
  @endpoint
end

#protocol ⇒ Object (readonly)

Returns the value of attribute protocol.



55
56
57
 
# File 'lib/async/redis/client.rb', line 55

def protocol
  @protocol
end

Class Method Details

.open(*arguments) {|client, task| ... } ⇒ client

Returns if no block provided.

Yields:

  • (client, task) —

    yield the client in an async task.

Returns:

  • (client) —

    if no block provided.



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/async/redis/client.rb', line 59

def self.open(*arguments, &block)
  client = self.new(*arguments)
  
  return client unless block_given?
  
  Async do |task|
    begin
      yield client, task
    ensure
      client.close
    end
  end.wait
end

Instance Method Details

#call(*arguments) ⇒ Object 



118
119
120
121
122
123
124
125
126
 
# File 'lib/async/redis/client.rb', line 118

def call(*arguments)
  @pool.acquire do |connection|
    connection.write_request(arguments)
    
    connection.flush
    
    return connection.read_response
  end
end

#close ⇒ Object 



73
74
75
 
# File 'lib/async/redis/client.rb', line 73

def close
  @pool.close
end

#pipeline(&block) ⇒ Object Also known as: nested 



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/async/redis/client.rb', line 103

def pipeline(&block)
  context = Context::Pipeline.new(@pool)
  
  return context unless block_given?
  
  begin
    yield context
  ensure
    context.close
  end
end

#subscribe(*channels) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/async/redis/client.rb', line 77

def subscribe(*channels)
  context = Context::Subscribe.new(@pool, channels)
  
  return context unless block_given?
  
  begin
    yield context
  ensure
    context.close
  end
end

#transaction(&block) ⇒ Object Also known as: multi 



89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/async/redis/client.rb', line 89

def transaction(&block)
  context = Context::Transaction.new(@pool)
  
  return context unless block_given?
  
  begin
    yield context
  ensure
    context.close
  end
end