|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OutgoingMessageQueue
Priority-based outbound peer message queue.
Nested Class Summary | |
---|---|
static interface |
OutgoingMessageQueue.MessageQueueListener
Receive notification of queue events. |
Method Summary | |
---|---|
void |
addMessage(Message message,
boolean manual_listener_notify)
Add a message to the message queue. |
void |
cancelQueueListener(OutgoingMessageQueue.MessageQueueListener listener)
Cancel queue event notification listener. |
int[] |
deliverToTransport(int max_bytes,
boolean protocol_is_free,
boolean manual_listener_notify)
Deliver (write) message(s) data to the underlying transport. |
void |
destroy()
Destroy this queue; i.e. |
void |
doListenerNotifications()
Manually send any unsent listener notifications. |
void |
flush()
Force all pending messages to be delivered |
int |
getDataQueuedBytes()
|
MessageStreamEncoder |
getEncoder()
|
int |
getMssSize()
|
int |
getPercentDoneOfCurrentMessage()
Get the percentage of the current message that has already been sent out. |
boolean |
getPriorityBoost()
|
int |
getProtocolQueuedBytes()
|
java.lang.String |
getQueueTrace()
|
int |
getTotalSize()
Get the total number of bytes ready to be transported. |
boolean |
hasUrgentMessage()
Whether or not an urgent message (one that needs an immediate send, i.e. |
boolean |
isBlocked()
|
boolean |
isDestroyed()
|
void |
notifyOfExternallySentMessage(Message message)
Notifty the queue (and its listeners) of a message sent externally on the queue's behalf. |
Message |
peekFirstMessage()
|
void |
registerQueueListener(OutgoingMessageQueue.MessageQueueListener listener)
Add a listener to be notified of queue events. |
boolean |
removeMessage(Message message,
boolean manual_listener_notify)
Remove a particular message from the queue. |
void |
removeMessagesOfType(Message[] message_types,
boolean manual_listener_notify)
Remove all messages of the given types from the queue. |
void |
setEncoder(MessageStreamEncoder stream_encoder)
Set the message stream encoder that will be used to encode outgoing messages. |
void |
setPriorityBoost(boolean boost)
|
void |
setTrace(boolean on)
|
void |
setTransport(Transport _transport)
|
Method Detail |
---|
void setTransport(Transport _transport)
int getMssSize()
void setEncoder(MessageStreamEncoder stream_encoder)
stream_encoder
- to useMessageStreamEncoder getEncoder()
int getPercentDoneOfCurrentMessage()
void destroy()
boolean isDestroyed()
int getTotalSize()
int getDataQueuedBytes()
int getProtocolQueuedBytes()
boolean isBlocked()
boolean getPriorityBoost()
void setPriorityBoost(boolean boost)
boolean hasUrgentMessage()
Message peekFirstMessage()
void addMessage(Message message, boolean manual_listener_notify)
message
- message to addmanual_listener_notify
- true for manual notification, false for automaticvoid removeMessagesOfType(Message[] message_types, boolean manual_listener_notify)
message_types
- type to removemanual_listener_notify
- true for manual notification, false for automaticboolean removeMessage(Message message, boolean manual_listener_notify)
message
- to removemanual_listener_notify
- true for manual notification, false for automatic
int[] deliverToTransport(int max_bytes, boolean protocol_is_free, boolean manual_listener_notify) throws java.io.IOException
max_bytes
- maximum number of bytes to delivermanual_listener_notify
- true for manual notification, false for automatic
java.io.IOException
- on delivery errorvoid doListenerNotifications()
void flush()
void setTrace(boolean on)
java.lang.String getQueueTrace()
void registerQueueListener(OutgoingMessageQueue.MessageQueueListener listener)
listener
- void cancelQueueListener(OutgoingMessageQueue.MessageQueueListener listener)
listener
- void notifyOfExternallySentMessage(Message message)
message
- sent externally
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |