google-cloud-debugger - Class Google::Cloud::Debugger::Transmitter (v0.42.2)

Reference documentation and code samples for the google-cloud-debugger class Google::Cloud::Debugger::Transmitter.

Transmitter

Responsible for submit evaluated breakpoints back to Stackdriver Debugger service asynchronously. It maintains a thread pool.

The transmitter is controlled by the debugger agent it belongs to. Debugger agent submits evaluated breakpoint asynchronously, and the transmitter submits the breakpoints to Stackdriver Debugger service.

Inherits

  • Object

Methods

#agent

def agent() -> Google::Cloud::Debugger::Agent

The debugger agent this transmiter belongs to

Returns

#agent=

def agent=(value) -> Google::Cloud::Debugger::Agent

The debugger agent this transmiter belongs to

Parameter
Returns

#max_queue

def max_queue()
Aliases

Maximum backlog size for this transmitter's queue

#max_queue=

def max_queue=(value)
Aliases

Maximum backlog size for this transmitter's queue

#max_queue_size

def max_queue_size()
Alias Of: #max_queue

Maximum backlog size for this transmitter's queue

#max_queue_size=

def max_queue_size=(value)
Alias Of: #max_queue=

Maximum backlog size for this transmitter's queue

#on_error

def on_error(&block) { |error| ... }

Register to be notified of errors when raised.

If an unhandled error has occurred the transmitter will attempt to recover from the error and resume submitting breakpoints.

Multiple error handlers can be added.

Yields
  • (callback) — The block to be called when an error is raised.
Yield Parameter
  • error (Exception) — The error raised.

#start

def start() -> Transmitter

Starts the transmitter and its thread pool.

Returns
  • (Transmitter) — returns self so calls can be chained.

#started?

def started?() -> boolean

Whether the transmitter has been started.

Returns
  • (boolean) — true when started, false otherwise.

#stop

def stop(timeout = nil) -> Transmitter

Stops the transmitter and its thread pool. Once stopped, cannot be started again.

Returns
  • (Transmitter) — returns self so calls can be chained.

#stopped?

def stopped?() -> boolean

Whether the transmitter has been stopped.

Returns
  • (boolean) — true when stopped, false otherwise.

#submit

def submit(breakpoint)

Enqueue an evaluated breakpoint to be submitted by the transmitter.

Raises
  • (TransmitterError) — if there are no resources available to make queue the API call on the thread pool.

#threads

def threads()

Maximum threads used in the thread pool

#threads=

def threads=(value)

Maximum threads used in the thread pool