Class: Aikido::Zen::RPC::Client

Inherits:
Object
  • Object
show all
Includes:
IPC::FramedIO
Defined in:
lib/aikido/zen/ipc/rpc.rb

Constant Summary

Constants included from IPC::FramedIO

IPC::FramedIO::READ_CHUNK_SIZE

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(secret, host, port, connect_timeout: IPC::CONNECT_TIMEOUT, handshake_timeout: IPC::HANDSHAKE_TIMEOUT, read_timeout: IPC::READ_TIMEOUT, write_timeout: IPC::WRITE_TIMEOUT, max_read_size: nil, max_write_size: nil, reconnect: false, reconnect_delay: IPC::RECONNECT_DELAY, logger: Aikido::Zen.config.logger) ⇒ Client

Returns a new instance of Client.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/aikido/zen/ipc/rpc.rb', line 216

def initialize(
  secret,
  host,
  port,
  connect_timeout: IPC::CONNECT_TIMEOUT,
  handshake_timeout: IPC::HANDSHAKE_TIMEOUT,
  read_timeout: IPC::READ_TIMEOUT,
  write_timeout: IPC::WRITE_TIMEOUT,
  max_read_size: nil,
  max_write_size: nil,
  reconnect: false,
  reconnect_delay: IPC::RECONNECT_DELAY,
  logger: Aikido::Zen.config.logger
)
  @read_timeout = read_timeout
  @write_timeout = write_timeout
  @max_read_size = max_read_size
  @max_write_size = max_write_size
  @logger = logger

  @pending = Concurrent::Hash.new
  @write_mutex = Mutex.new

  @client = IPC::Client.new(
    secret,
    host,
    port,
    connect_timeout: connect_timeout,
    handshake_timeout: handshake_timeout,
    reconnect: reconnect,
    reconnect_delay: reconnect_delay
  )

  # Disable Nagle/delayed-ACK to optimize request/response latency
  @client.socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
end

Class Method Details

.start(secret, host, port, connect_timeout: IPC::CONNECT_TIMEOUT, handshake_timeout: IPC::HANDSHAKE_TIMEOUT, read_timeout: IPC::READ_TIMEOUT, write_timeout: IPC::WRITE_TIMEOUT, max_read_size: nil, max_write_size: nil, reconnect: false, reconnect_delay: IPC::RECONNECT_DELAY, logger: Aikido::Zen.config.logger, &block) ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/aikido/zen/ipc/rpc.rb', line 183

def self.start(
  secret,
  host,
  port,
  connect_timeout: IPC::CONNECT_TIMEOUT,
  handshake_timeout: IPC::HANDSHAKE_TIMEOUT,
  read_timeout: IPC::READ_TIMEOUT,
  write_timeout: IPC::WRITE_TIMEOUT,
  max_read_size: nil,
  max_write_size: nil,
  reconnect: false,
  reconnect_delay: IPC::RECONNECT_DELAY,
  logger: Aikido::Zen.config.logger,
  &block
)
  client = new(
    secret,
    host,
    port,
    connect_timeout: connect_timeout,
    handshake_timeout: handshake_timeout,
    read_timeout: read_timeout,
    write_timeout: write_timeout,
    max_read_size: max_read_size,
    max_write_size: max_write_size,
    reconnect: reconnect,
    reconnect_delay: reconnect_delay,
    logger: logger
  )
  client.start(&block)
  client
end

Instance Method Details

#close ⇒ Object 



253
254
255
 
# File 'lib/aikido/zen/ipc/rpc.rb', line 253

def close
  @client.close
end

#invoke(name, timeout, *args, **kwargs) ⇒ Object 



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/aikido/zen/ipc/rpc.rb', line 287

def invoke(name, timeout, *args, **kwargs)
  id = SecureRandom.uuid

  ivar = Concurrent::IVar.new

  @pending[id] = ivar

  @write_mutex.synchronize { write_message(@client.socket, [id, name, args, kwargs]) }

  ivar.wait!(timeout)

  raise Errno::ETIMEDOUT, "invoke timed out" if ivar.incomplete?

  ivar.value
ensure
  @pending.delete(id)
end

#start(&block) ⇒ Object 



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/aikido/zen/ipc/rpc.rb', line 257

def start(&block)
  @client.start do |socket|
    @logger.info("RPC client connected")

    block&.call

    handle_messages(socket)
  rescue => err
    @logger.error("RPC client error: #{err.class}: #{err.message}")
    @logger.debug(err.backtrace.join("\n"))

    raise
  ensure
    @logger.info("RPC client disconnected")

    @pending.each_value { |ivar| ivar.fail(err) }
    @pending.clear
  end
end

#stop ⇒ Object 



277
278
279
280
281
282
283
284
285
 
# File 'lib/aikido/zen/ipc/rpc.rb', line 277

def stop
  @client.stop do
    # shutdown(SHUT_RDWR) wakes every thread in every process blocked in
    # read or write (or select) on the socket.
    @client.socket.shutdown(Socket::SHUT_RDWR)
  rescue IOError
    # already closed
  end
end