MessengerImpl (proton-project 0.5 API)

java.lang.Object
- org.apache.qpid.proton.messenger.impl.MessengerImpl

All Implemented Interfaces:: Messenger

public class MessengerImpl
extends Object
implements Messenger

Field Summary
- Fields inherited from interface org.apache.qpid.proton.messenger.Messenger
  CUMULATIVE

Constructor Summary

Constructors
Constructor and Description
`MessengerImpl()` Deprecated. This constructor's visibility will be reduced to the default scope in a future release. Client code outside this module should use a `MessengerFactory` instead
`MessengerImpl(String name)` Deprecated. This constructor's visibility will be reduced to the default scope in a future release. Client code outside this module should use a `MessengerFactory` instead

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`accept(Tracker tracker, int flags)` Accepts messages retrieved from the incoming message queue.
`Message`	`get()` Returns the message from the head of the incoming message queue.
`int`	`getIncomingWindow()`
`int`	`getOutgoingWindow()`
`Status`	`getStatus(Tracker tracker)` Gets the last known remote state of the delivery associated with the given tracker.
`long`	`getTimeout()`
`int`	`incoming()` Returns a count of the messages available on the incoming queue.
`Tracker`	`incomingTracker()` Returns a token which can be used to accept or reject the message returned in the previous get() call.
`void`	`interrupt()`
`boolean`	`isBlocking()`
`int`	`outgoing()` Returns a count of the messages currently on the outgoing queue (i.e.
`Tracker`	`outgoingTracker()` Returns a token which can be used to track the status of the message of the previous put() call.
`void`	`put(Message m)` Places the content contained in the message onto the outgoing queue of the Messenger.
`int`	`receiving()`
`void`	`recv()` Receives an arbitrary number of messages into the incoming queue of the Messenger.
`void`	`recv(int n)` Receives up to the specified number of messages into the incoming queue of the Messenger.
`void`	`reject(Tracker tracker, int flags)` Rejects messages retrieved from the incoming message queue.
`void`	`send()` Blocks until the outgoing queue is empty and, in the event that an outgoing window has been set, until the messages in that window have been received by the target to which they were sent, or the operation times out.
`void`	`send(int n)`
`void`	`setBlocking(boolean b)`
`void`	`setIncomingWindow(int window)`
`void`	`setOutgoingWindow(int window)`
`void`	`setTimeout(long timeInMillis)`
`void`	`settle(Tracker tracker, int flags)`
`void`	`start()` Transitions the Messenger to an active state.
`void`	`stop()` Transitions the Messenger to an inactive state.
`boolean`	`stopped()`
`void`	`subscribe(String source)` Subscribes the Messenger to messages originating from the specified source.
`String`	`toString()`
`boolean`	`work(long timeout)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MessengerImpl
```
@Deprecated
public MessengerImpl()
```
    Deprecated. This constructor's visibility will be reduced to the default scope in a future release. Client code outside this module should use a MessengerFactory instead
  - MessengerImpl
```
@Deprecated
public MessengerImpl(String name)
```
    Deprecated. This constructor's visibility will be reduced to the default scope in a future release. Client code outside this module should use a MessengerFactory instead
- Method Detail
  - setTimeout
```
public void setTimeout(long timeInMillis)
```
    Specified by:
    
    setTimeout in interface Messenger
  - getTimeout
```
public long getTimeout()
```
    Specified by:
    
    getTimeout in interface Messenger
  - isBlocking
```
public boolean isBlocking()
```
    Specified by:
    
    isBlocking in interface Messenger
  - setBlocking
```
public void setBlocking(boolean b)
```
    Specified by:
    
    setBlocking in interface Messenger
  - start
```
public void start()
           throws IOException
```
    Description copied from interface: Messenger
    
    Transitions the Messenger to an active state. A Messenger is initially created in an inactive state. When inactive, a Messenger will not send or receive messages from its internal queues. A Messenger must be started before calling send() or recv().
    
    Specified by:
    
    start in interface Messenger
    
    Throws:
    
    IOException
  - stop
```
public void stop()
```
    Description copied from interface: Messenger
    
    Transitions the Messenger to an inactive state. An inactive Messenger will not send or receive messages from its internal queues. A Messenger should be stopped before being discarded to ensure a clean shutdown handshake occurs on any internally managed connections.
    
    Specified by:
    
    stop in interface Messenger
  - stopped
```
public boolean stopped()
```
    Specified by:
    
    stopped in interface Messenger
  - work
```
public boolean work(long timeout)
```
    Specified by:
    
    work in interface Messenger
  - interrupt
```
public void interrupt()
```
    Specified by:
    
    interrupt in interface Messenger
  - put
```
public void put(Message m)
         throws MessengerException
```
    Description copied from interface: Messenger
    
    Places the content contained in the message onto the outgoing queue of the Messenger. This method will never block. The send call may be used to block until the messages are sent. Either a send() or a recv() call is neceesary at present to cause the messages to actually be sent out.
    
    Specified by:
    
    put in interface Messenger
    
    Throws:
    
    MessengerException
  - send
```
public void send()
          throws TimeoutException
```
    Description copied from interface: Messenger
    
    Blocks until the outgoing queue is empty and, in the event that an outgoing window has been set, until the messages in that window have been received by the target to which they were sent, or the operation times out. The timeout property controls how long a Messenger will block before timing out.
    
    Specified by:
    
    send in interface Messenger
    
    Throws:
    
    TimeoutException
  - send
```
public void send(int n)
          throws TimeoutException
```
    Specified by:
    
    send in interface Messenger
    
    Throws:
    
    TimeoutException
  - recv
```
public void recv(int n)
          throws TimeoutException
```
    Description copied from interface: Messenger
    
    Receives up to the specified number of messages into the incoming queue of the Messenger. This method will block until at least one message is available or the operation times out.
    
    Specified by:
    
    recv in interface Messenger
    
    Throws:
    
    TimeoutException
  - recv
```
public void recv()
          throws TimeoutException
```
    Description copied from interface: Messenger
    
    Receives an arbitrary number of messages into the incoming queue of the Messenger. This method will block until at least one message is available or the operation times out.
    
    Specified by:
    
    recv in interface Messenger
    
    Throws:
    
    TimeoutException
  - receiving
```
public int receiving()
```
  - get
```
public Message get()
```
    Description copied from interface: Messenger
    
    Returns the message from the head of the incoming message queue.
    
    Specified by:
    
    get in interface Messenger
  - subscribe
```
public void subscribe(String source)
               throws MessengerException
```
    Description copied from interface: Messenger
    
    Subscribes the Messenger to messages originating from the specified source. The source is an address as specified in the Messenger introduction with the following addition. If the domain portion of the address begins with the '~' character, the Messenger will interpret the domain as host/port, bind to it, and listen for incoming messages. For example "~0.0.0.0", "amqp://~0.0.0.0" will bind to any local interface and listen for incoming messages.
    
    Specified by:
    
    subscribe in interface Messenger
    
    Throws:
    
    MessengerException
  - outgoing
```
public int outgoing()
```
    Description copied from interface: Messenger
    
    Returns a count of the messages currently on the outgoing queue (i.e. those that have been put() but not yet actually sent out).
    
    Specified by:
    
    outgoing in interface Messenger
  - incoming
```
public int incoming()
```
    Description copied from interface: Messenger
    
    Returns a count of the messages available on the incoming queue.
    
    Specified by:
    
    incoming in interface Messenger
  - getIncomingWindow
```
public int getIncomingWindow()
```
    Specified by:
    
    getIncomingWindow in interface Messenger
  - setIncomingWindow
```
public void setIncomingWindow(int window)
```
    Specified by:
    
    setIncomingWindow in interface Messenger
  - getOutgoingWindow
```
public int getOutgoingWindow()
```
    Specified by:
    
    getOutgoingWindow in interface Messenger
  - setOutgoingWindow
```
public void setOutgoingWindow(int window)
```
    Specified by:
    
    setOutgoingWindow in interface Messenger
  - incomingTracker
```
public Tracker incomingTracker()
```
    Description copied from interface: Messenger
    
    Returns a token which can be used to accept or reject the message returned in the previous get() call.
    
    Specified by:
    
    incomingTracker in interface Messenger
  - outgoingTracker
```
public Tracker outgoingTracker()
```
    Description copied from interface: Messenger
    
    Returns a token which can be used to track the status of the message of the previous put() call.
    
    Specified by:
    
    outgoingTracker in interface Messenger
  - reject
```
public void reject(Tracker tracker,
          int flags)
```
    Description copied from interface: Messenger
    
    Rejects messages retrieved from the incoming message queue. The tracker object for a message is obtained through a call to incomingTracker() following a get(). If the flags argument contains CUMULATIVE, then all message up to the one identified by the tracker will be rejected.
    
    Specified by:
    
    reject in interface Messenger
  - accept
```
public void accept(Tracker tracker,
          int flags)
```
    Description copied from interface: Messenger
    
    Accepts messages retrieved from the incoming message queue. The tracker object for a message is obtained through a call to incomingTracker() following a get(). If the flags argument contains CUMULATIVE, then all message up to the one identified by the tracker will be accepted.
    
    Specified by:
    
    accept in interface Messenger
  - settle
```
public void settle(Tracker tracker,
          int flags)
```
    Specified by:
    
    settle in interface Messenger
  - getStatus
```
public Status getStatus(Tracker tracker)
```
    Description copied from interface: Messenger
    
    Gets the last known remote state of the delivery associated with the given tracker.
    
    Specified by:
    
    getStatus in interface Messenger
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MessengerImpl

Field Summary

Fields inherited from interface org.apache.qpid.proton.messenger.Messenger

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MessengerImpl

MessengerImpl

Method Detail

setTimeout

getTimeout

isBlocking

setBlocking

start

stop

stopped

work

interrupt

put

send

send

recv

recv

receiving

get

subscribe

outgoing

incoming

getIncomingWindow

setIncomingWindow

getOutgoingWindow

setOutgoingWindow

incomingTracker

outgoingTracker

reject

accept

settle

getStatus

toString