|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.snmp4j.util.MultiThreadedMessageDispatcher
public class MultiThreadedMessageDispatcher
The MultiThreadedMessageDispatcher class is a decorator
for any MessageDispatcher instances that processes incoming
message with a supplied ThreadPool. The processing is thus
parallelized on up to the size of the supplied thread pool threads.
| Constructor Summary | |
|---|---|
MultiThreadedMessageDispatcher(WorkerPool workerPool,
MessageDispatcher decoratedDispatcher)
Creates a multi thread message dispatcher using the provided ThreadPool to concurrently process incoming messages
that are forwarded to the supplied decorated
MessageDispatcher. |
|
| Method Summary | |
|---|---|
void |
addCommandResponder(CommandResponder listener)
Adds a CommandResponder instance to the message dispatcher. |
void |
addMessageProcessingModel(MessageProcessingModel model)
Adds a MessageProcessingModel to the dispatcher. |
void |
addTransportMapping(TransportMapping transport)
Adds a TransportMapping to the dispatcher. |
MessageProcessingModel |
getMessageProcessingModel(int messageProcessingModel)
Gets the MessageProcessingModel for the supplied message
processing model ID. |
int |
getNextRequestID()
Gets the next unique request ID. |
TransportMapping |
getTransport(Address destAddress)
Returns a transport mapping that can handle the supplied address. |
java.util.Collection |
getTransportMappings()
Gets the Collection of transport mappings in this message
dispatcher. |
void |
processMessage(TransportMapping sourceTransport,
Address incomingAddress,
BERInputStream wholeMessage)
Process an incoming SNMP message. |
void |
processMessage(TransportMapping sourceTransport,
Address incomingAddress,
java.nio.ByteBuffer wholeMessage)
Process an incoming SNMP message. |
void |
releaseStateReference(int messageProcessingModel,
PduHandle pduHandle)
Release any state references associated with the supplied PduHandle in the specified message processing model. |
void |
removeCommandResponder(CommandResponder listener)
Removes a previously added CommandResponder instance from
the message dispatcher. |
void |
removeMessageProcessingModel(MessageProcessingModel model)
Removes a previously added MessageProcessingModel from
the dispatcher. |
TransportMapping |
removeTransportMapping(TransportMapping transport)
Removes a previously added TransportMapping from
the dispatcher. |
int |
returnResponsePdu(int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
int maxSizeResponseScopedPDU,
StateReference stateReference,
StatusInformation statusInformation)
Returns a response PDU to the sender of the corresponding request PDU. |
PduHandle |
sendPdu(Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse)
Sends a PDU to the supplied transport address. |
PduHandle |
sendPdu(TransportMapping transportMapping,
Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse)
Sends a PDU to the supplied transport address. |
PduHandle |
sendPdu(TransportMapping transportMapping,
Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse,
PduHandleCallback callback)
Sends a PDU to the supplied transport address and returns the PduHandle that uniquely identifies the request as response
after the request has been sent and otional, if a
PduHandleCallback is given, it returns also the
PduHandle just before the request is sent through the
the callback interface. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public MultiThreadedMessageDispatcher(WorkerPool workerPool,
MessageDispatcher decoratedDispatcher)
ThreadPool to concurrently process incoming messages
that are forwarded to the supplied decorated
MessageDispatcher.
workerPool - a WorkerPool instance (that can be shared). The worker
pool has to be stopped externally.decoratedDispatcher - the decorated MessageDispatcher that must be
multi-threading safe.| Method Detail |
|---|
public int getNextRequestID()
MessageDispatcher
getNextRequestID in interface MessageDispatcherpublic void addMessageProcessingModel(MessageProcessingModel model)
MessageDispatcherMessageProcessingModel to the dispatcher. In order to
support a specific SNMP protocol version, the message dispatcher needs
a message processing model to process messages before they can be
dispatched.
addMessageProcessingModel in interface MessageDispatchermodel - a MessageProcessingModel instance.public void removeMessageProcessingModel(MessageProcessingModel model)
MessageDispatcherMessageProcessingModel from
the dispatcher.
removeMessageProcessingModel in interface MessageDispatchermodel - a MessageProcessingModel instance.public MessageProcessingModel getMessageProcessingModel(int messageProcessingModel)
MessageDispatcherMessageProcessingModel for the supplied message
processing model ID.
getMessageProcessingModel in interface MessageDispatchermessageProcessingModel - a message processing model ID
(see MessageProcessingModel.getID()).
nullpublic void addTransportMapping(TransportMapping transport)
MessageDispatcherTransportMapping to the dispatcher. The transport mapping
is used to send and receive messages to/from the network.
addTransportMapping in interface MessageDispatchertransport - a TransportMapping instance.public TransportMapping removeTransportMapping(TransportMapping transport)
MessageDispatcherTransportMapping from
the dispatcher.
removeTransportMapping in interface MessageDispatchertransport - a TransportMapping instance.
TransportMapping instance supplied if it
could be successfully removed, null otherwise.public java.util.Collection getTransportMappings()
MessageDispatcherCollection of transport mappings in this message
dispatcher.
getTransportMappings in interface MessageDispatcherpublic void addCommandResponder(CommandResponder listener)
MessageDispatcherCommandResponder instance to the message dispatcher.
Successfully processed SNMP messages will be presented to all command
responder (in the order in which they have been added) until a responder
uses the CommandResponderEvent.setProcessed(boolean processed)
to set the processed status of the event to true.
addCommandResponder in interface MessageDispatcherlistener - a CommandResponder instance.public void removeCommandResponder(CommandResponder listener)
MessageDispatcherCommandResponder instance from
the message dispatcher.
removeCommandResponder in interface MessageDispatcherlistener - a CommandResponder instance.
public PduHandle sendPdu(Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse)
throws MessageException
MessageDispatcherMessageDispatcher.sendPdu(TransportMapping transportMapping,
Address transportAddress, int messageProcessingModel,
int securityModel, byte[] securityName, int securityLevel, PDU pdu,
boolean expectResponse) with transportMapping set to
null.
sendPdu in interface MessageDispatchertransportAddress - the target transport address.messageProcessingModel - typically the SNMP version.securityModel - Security Model to use.securityName - on behalf of this principal.securityLevel - Level of Security requested.pdu - the SNMP Protocol Data UnitexpectResponse - true if a response is expected and a state reference should
be saved (if needed for the supplied message processing model).
PduHandle that uniquely identifies this request.
MessageException
public PduHandle sendPdu(TransportMapping transportMapping,
Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse)
throws MessageException
MessageDispatcher
sendPdu in interface MessageDispatchertransportMapping - the TransportMapping to be used to send the PDU. If
transportMapping is null the message
dispatcher will determine the appropriate transport mapping for the
given transport address.transportAddress - the target transport address.messageProcessingModel - typically the SNMP version.securityModel - Security Model to use.securityName - on behalf of this principal.securityLevel - Level of Security requested.pdu - the SNMP Protocol Data UnitexpectResponse - true if a response is expected and a state reference should
be saved (if needed for the supplied message processing model).
PduHandle that uniquely identifies this request.
MessageException
public PduHandle sendPdu(TransportMapping transportMapping,
Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse,
PduHandleCallback callback)
throws MessageException
MessageDispatcherPduHandle that uniquely identifies the request as response
after the request has been sent and otional, if a
PduHandleCallback is given, it returns also the
PduHandle just before the request is sent through the
the callback interface.
sendPdu in interface MessageDispatchertransportMapping - the TransportMapping to be used to send the PDU. If
transportMapping is null the message
dispatcher will determine the appropriate transport mapping for the
given transport address.transportAddress - the target transport address.messageProcessingModel - typically the SNMP version.securityModel - Security Model to use.securityName - on behalf of this principal.securityLevel - Level of Security requested.pdu - the SNMP Protocol Data UnitexpectResponse - true if a response is expected and a state reference should
be saved (if needed for the supplied message processing model).callback - an optional callback instance that is informed (if not
null) about the newly assigned PduHandle just before the
message is sent out.
PduHandle that uniquely identifies this request.
MessageException
public int returnResponsePdu(int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
int maxSizeResponseScopedPDU,
StateReference stateReference,
StatusInformation statusInformation)
throws MessageException
MessageDispatcher
returnResponsePdu in interface MessageDispatchermessageProcessingModel - intsecurityModel - intsecurityName - byte[]securityLevel - intpdu - PDUmaxSizeResponseScopedPDU - intstateReference - StateReferencestatusInformation - StatusInformation
MessageException
public void processMessage(TransportMapping sourceTransport,
Address incomingAddress,
BERInputStream wholeMessage)
MessageDispatcher
processMessage in interface MessageDispatchersourceTransport - a TransportMapping instance denoting the transport that
received the message and that will be used to send any responses to
this message. The sourceTransport has to support the
incomingAddress's implementation class.incomingAddress - the Address from which the message has been received.wholeMessage - an BERInputStream containing the received SNMP message.
The supplied input stream must support marks, otherwise an
IllegalArgumentException is thrown.
public void processMessage(TransportMapping sourceTransport,
Address incomingAddress,
java.nio.ByteBuffer wholeMessage)
MessageDispatcher
processMessage in interface MessageDispatcherprocessMessage in interface TransportListenersourceTransport - a TransportMapping instance denoting the transport that
received the message and that will be used to send any responses to
this message. The sourceTransport has to support the
incomingAddress's implementation class.incomingAddress - the Address from which the message has been received.wholeMessage - an ByteBuffer containing the received SNMP message.
public void releaseStateReference(int messageProcessingModel,
PduHandle pduHandle)
MessageDispatcherPduHandle in the specified message processing model.
releaseStateReference in interface MessageDispatchermessageProcessingModel - a message processing model ID.pduHandle - the PduHandle that identifies a confirmed class message.MessageProcessingModelpublic TransportMapping getTransport(Address destAddress)
MessageDispatcher
getTransport in interface MessageDispatcherdestAddress - an Address instance.
TransportMapping instance that can be used to sent
a SNMP message to destAddress or null if
such a transport mapping does not exists.
|
Copyright 2003-2009 Frank Fock and Jochen Katz (SNMP4J.org) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||