Class Qpid::Proton::Endpoint
In: lib/core/endpoint.rb
Parent: Object

Endpoint is the parent classes for Link and Session.

It provides a namespace for constant values that relate to the current state of both links and sessions.

@example 

  conn = Qpid::Proton::Connection.new
  puts "Local connection flags : #{conn.state || Qpid::Proton::Endpoint::LOCAL_MASK}"
  puts "Remote connection flags: #{conn.state || Qpid::Proton::Endpoint::REMOTE_MASK}"

Methods

check_state   closed?   condition   local_active?   local_closed?   local_condition   local_open?   local_uninit?   open?   remote_active?   remote_closed?   remote_condition   remote_open?   remote_uninit?   transport   work_queue  

Included Modules

Util::Deprecation

Constants

LOCAL_UNINIT = Cproton::PN_LOCAL_UNINIT   The local connection is uninitialized.
LOCAL_ACTIVE = Cproton::PN_LOCAL_ACTIVE   The local connection is active.
LOCAL_CLOSED = Cproton::PN_LOCAL_CLOSED   The local connection is closed.
REMOTE_UNINIT = Cproton::PN_REMOTE_UNINIT   The remote connection is unitialized.
REMOTE_ACTIVE = Cproton::PN_REMOTE_ACTIVE   The remote connection is active.
REMOTE_CLOSED = Cproton::PN_REMOTE_CLOSED   The remote connection is closed.
LOCAL_MASK = Cproton::PN_LOCAL_UNINIT | Cproton::PN_LOCAL_ACTIVE | Cproton::PN_LOCAL_CLOSED   Bitmask for the local-only flags.
REMOTE_MASK = Cproton::PN_REMOTE_UNINIT | Cproton::PN_REMOTE_ACTIVE | Cproton::PN_REMOTE_CLOSED   Bitmask for the remote-only flags.

Public Instance methods

check_state(mask)

@private @return [Bool] true if {state} has all the bits of `mask` set

closed?()

@return [Bool] true if endpoint has sent and received a CLOSE frame

condition()

@private

local_active?()

Alias for local_open?

open?()

@return [Bool] true if endpoint has sent and received an OPEN frame

remote_active?()

Alias for remote_open?

transport()

Return the transport associated with this endpoint.

@return [Transport] The transport.

work_queue()

@return [WorkQueue] the work queue for work on this endpoint.

[Validate]