Module org.snmp4j

Class ResponseEvent<A extends Address>

  • Type Parameters:
    A - type of the peer Address.
    All Implemented Interfaces:
    java.io.Serializable

    public class ResponseEvent<A extends Address>
    extends java.util.EventObject
    ResponseEvent associates a request PDU with the corresponding response and an optional user object.
    Version:
    3.1.0
    Author:
    Frank Fock
    See Also:
    Serialized Form
    • Field Summary

      • Fields inherited from class java.util.EventObject

        source
    • Constructor Summary

      Constructors 
      Constructor Description
      ResponseEvent​(java.lang.Object source, A peerAddress, PDU request, PDU response, java.lang.Object userObject)
      Creates an ResponseEvent instance.
      ResponseEvent​(java.lang.Object source, A peerAddress, PDU request, PDU response, java.lang.Object userObject, java.lang.Exception error)
      Creates an ResponseEvent instance with an exception object indicating a message processing error.
    • Constructor Detail

      • ResponseEvent

        public ResponseEvent​(java.lang.Object source,
                             A peerAddress,
                             PDU request,
                             PDU response,
                             java.lang.Object userObject)
        Creates an ResponseEvent instance.
        Parameters:
        source - the event source.
        peerAddress - the transport address of the entity that send the response.
        request - the request PDU (must not be null).
        response - the response PDU or null if the request timed out.
        userObject - an optional user object.
      • ResponseEvent

        public ResponseEvent​(java.lang.Object source,
                             A peerAddress,
                             PDU request,
                             PDU response,
                             java.lang.Object userObject,
                             java.lang.Exception error)
        Creates an ResponseEvent instance with an exception object indicating a message processing error.
        Parameters:
        source - the event source.
        peerAddress - the transport address of the entity that send the response.
        request - the request PDU (must not be null).
        response - the response PDU or null if the request timed out.
        userObject - an optional user object.
        error - an Exception.
    • Method Detail

      • getRequest

        public PDU getRequest()
        Gets the request PDU.
        Returns:
        a PDU.
      • setPeerAddress

        protected final void setPeerAddress​(A peerAddress)
      • setRequest

        protected final void setRequest​(PDU request)
      • setResponse

        protected final void setResponse​(PDU response)
      • getResponse

        public PDU getResponse()
        Gets the response PDU.
        Returns:
        a PDU instance if a response has been received. If the request timed out then null will be returned.
      • setUserObject

        protected final void setUserObject​(java.lang.Object userObject)
      • getError

        public java.lang.Exception getError()
        Gets the exception object from the exception that has been generated when the request processing has failed due to an error.
        Returns:
        an Exception instance.
      • getPeerAddress

        public A getPeerAddress()
        Gets the transport address of the response sender.
        Returns:
        the transport Address of the command responder that send this response, or null if no response has been received within the time-out interval or if an error occured (see getError()).