Home       Trees       Indices       Help   
Package qpid :: Package messaging :: Module endpoints :: Class Receiver
[hide private]
[frames] | no frames]

Class Receiver

source code

Endpoint --+
           |
  object --+
           |
          Receiver

Receives incoming messages from a remote source. Messages may be fetched with fetch.

Instance Methods [hide private]
 
__init__(self, session, id, source, options)
x.__init__(...) initializes x; see help(type(x)) for signature		 source code
 
_set_capacity(self, c, wakeup=True) source code
 
_get_capacity(self) source code
 
_wakeup(self) source code
 
check_error(self) source code
 
get_error(self) source code
 
_ewait(self, predicate, timeout=None) source code
 
check_closed(self) source code
 
unsettled(self)
Returns the number of acknowledged messages awaiting confirmation.		 source code
int
available(self)
Returns the number of messages available to be fetched by the application.		 source code
 
fetch(self, timeout=None)
Fetch and return a single message.		 source code
 
_grant(self) source code
 
close(self, timeout=None)
Close the receiver.		 source code

Inherited from Endpoint (private): _ecwait

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]
  capacity

Inherited from object: __class__

Method Details [hide private]

__init__(self, session, id, source, options)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

_set_capacity(self, c, wakeup=True)

source code 
Decorators:
  • @synchronized

unsettled(self)

source code 

Returns the number of acknowledged messages awaiting confirmation.

Decorators:
  • @synchronized

available(self)

source code 

Returns the number of messages available to be fetched by the application.

Returns: int
the number of available messages
Decorators:
  • @synchronized

fetch(self, timeout=None)

source code 

Fetch and return a single message. A timeout of None will block forever waiting for a message to arrive, a timeout of zero will return immediately if no messages are available.

Parameters:
  • timeout (float) - the time to wait for a message to be available
Decorators:
  • @synchronized

close(self, timeout=None)

source code 

Close the receiver.

Decorators:
  • @synchronized

Property Details [hide private]

capacity

Get Method:
_get_capacity(self)
Set Method:
_set_capacity(self, c, wakeup=True)

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Thu Aug 23 15:33:37 2012 http://epydoc.sourceforge.net