Package org.apache.qpid.protonj2.engine

Interface Connection

    • Method Detail

      • negotiate

        Connection negotiate()
              throws EngineStateException
        If not already negotiated this method initiates the AMQP protocol negotiation phase of the connection process sending the AMQPHeader to the remote peer. For a client application this could mean requesting the server to indicate if it supports the version of the protocol this client speaks. In rare cases a server could use this to preemptively send its AMQP header. Once a header is sent the remote should respond with the AMQP Header that indicates what protocol level it supports and if there is a mismatch the the engine will be failed with a error indicating the protocol support was not successfully negotiated. If the engine has a configured SASL layer then by starting the AMQP Header exchange this will implicitly first attempt the SASL authentication step of the connection process.
        Returns:
        this Connection instance.
        Throws:
        EngineStateException - if the Engine state precludes accepting new input.

      • negotiate

        Connection negotiate​(EventHandler<AMQPHeader> remoteAMQPHeaderHandler)
              throws EngineStateException
        If not already negotiated this method initiates the AMQP protocol negotiation phase of the connection process sending the AMQPHeader to the remote peer. For a client application this could mean requesting the server to indicate if it supports the version of the protocol this client speaks. In rare cases a server could use this to preemptively send its AMQP header. Once a header is sent the remote should respond with the AMQP Header that indicates what protocol level it supports and if there is a mismatch the the engine will be failed with a error indicating the protocol support was not successfully negotiated. If the engine has a configured SASL layer then by starting the AMQP Header exchange this will implicitly first attempt the SASL authentication step of the connection process. The provided remote AMQP Header handler will be called once the remote sends its AMQP Header to the either preemptively or as a response to offered AMQP Header from this peer, even if that has already happened prior to this call.
        Parameters:
        remoteAMQPHeaderHandler - Handler to be called when an AMQP Header response has arrived.
        Returns:
        this Connection instance.
        Throws:
        EngineStateException - if the Engine state precludes accepting new input.

      • tick

        long tick​(long current)
   throws java.lang.IllegalStateException,
          EngineStateException
        Performs a tick operation on the connection which checks that Connection Idle timeout processing is run. This method is a convenience method that delegates the work to the Engine.tick(long) method. It is an error to call this method if tickAuto(ScheduledExecutorService) was called.
        Parameters:
        current - Current time value usually taken from System.nanoTime()
        Returns:
        the absolute deadline in milliseconds to next call tick by/at, or 0 if there is none.
        Throws:
        java.lang.IllegalStateException - if the Engine is already performing auto tick handling.
        EngineStateException - if the Engine state precludes accepting new input.
        See Also:
        Engine.tick(long)

      • getState

        ConnectionState getState()
        Returns:
        the local connection state only

      • getContainerId

        java.lang.String getContainerId()
        Returns:
        the Container ID assigned to this Connection

      • setContainerId

        Connection setContainerId​(java.lang.String containerId)
                   throws java.lang.IllegalStateException
        Sets the Container Id to be used when opening this Connection. The container Id can only be modified prior to a call to Endpoint.open(), once the connection has been opened locally an error will be thrown if this method is called.
        Parameters:
        containerId - The Container Id used for this end of the Connection.
        Returns:
        this connection.
        Throws:
        java.lang.IllegalStateException - if the Connection has already been opened.

      • setHostname

        Connection setHostname​(java.lang.String hostname)
                throws java.lang.IllegalStateException
        Set the name of the host (either fully qualified or relative) to which this connection is connecting to. This information may be used by the remote peer to determine the correct back-end service to connect the client to. This value will be sent in the Open performative. Note that it is illegal to set the host name to a numeric IP address or include a port number. The host name value can only be modified prior to a call to Endpoint.open(), once the connection has been opened locally an error will be thrown if this method is called.
        Parameters:
        hostname - the RFC1035 compliant host name.
        Returns:
        this connection.
        Throws:
        java.lang.IllegalStateException - if the Connection has already been opened.

      • getHostname

        java.lang.String getHostname()
        Returns:
        returns the host name assigned to this Connection.
        See Also:
        setHostname(java.lang.String)

      • setChannelMax

        Connection setChannelMax​(int channelMax)
                  throws java.lang.IllegalStateException
        Set the channel max value for this Connection. The channel max value can only be modified prior to a call to Endpoint.open(), once the connection has been opened locally an error will be thrown if this method is called.
        Parameters:
        channelMax - The value to set for channel max when opening the connection.
        Returns:
        this connection.
        Throws:
        java.lang.IllegalStateException - if the Connection has already been opened.

      • getChannelMax

        int getChannelMax()
        Returns:
        the currently configured channel max for this Connection

      • setMaxFrameSize

        Connection setMaxFrameSize​(long maxFrameSize)
                    throws java.lang.IllegalStateException
        Sets the maximum frame size allowed for this connection, which is the largest single frame that the remote can send to this Connection before it will close the connection with an error condition indicating the violation. The legal range for this value is defined as (512 - 2^32-1) bytes. The max frame size value can only be modified prior to a call to Endpoint.open(), once the connection has been opened locally an error will be thrown if this method is called.
        Parameters:
        maxFrameSize - The maximum number of bytes allowed for a single
        Returns:
        this connection.
        Throws:
        java.lang.IllegalStateException - if the Connection has already been opened.

      • getMaxFrameSize

        long getMaxFrameSize()
        Returns:
        the currently configured max frame size this connection will accept.

      • setIdleTimeout

        Connection setIdleTimeout​(long idleTimeout)
                   throws java.lang.IllegalStateException
        Set the idle timeout value for this Connection. The idle timeout value can only be modified prior to a call to Endpoint.open(), once the connection has been opened locally an error will be thrown if this method is called.
        Parameters:
        idleTimeout - The value to set for the idle timeout when opening the connection.
        Returns:
        this connection.
        Throws:
        java.lang.IllegalStateException - if the Connection has already been opened.

      • getIdleTimeout

        long getIdleTimeout()
        Returns:
        the currently configured idle timeout for this Connection

      • session

        Session session()
         throws java.lang.IllegalStateException
        Creates a new Session linked to this Connection
        Returns:
        a newly created Session linked to this Connection.
        Throws:
        java.lang.IllegalStateException - if the Connection has already been closed.

      • sessions

        java.util.Set<Session> sessions()
        Returns an unmodifiable Set of Sessions that are tracked by the Connection. The Session instances returned from this method will be locally or remotely open or both which gives the caller full view of the complete set of known Session instances.
        Returns:
        an unmodifiable Set of Sessions tracked by this Connection.

      • getRemoteContainerId

        java.lang.String getRemoteContainerId()
        Returns:
        the Container Id assigned to the remote end of the Connection.

      • getRemoteHostname

        java.lang.String getRemoteHostname()
        Returns:
        the host name assigned to the remote end of this Connection.

      • getRemoteIdleTimeout

        long getRemoteIdleTimeout()
        Returns:
        the idle timeout value provided by the remote end of this Connection.

      • getRemoteMaxFrameSize

        long getRemoteMaxFrameSize()
        Returns:
        the remote set max frame size limit.

      • getRemoteState

        ConnectionState getRemoteState()
        Returns:
        the remote state (as last communicated)

      • sessionOpenHandler

        Connection sessionOpenHandler​(EventHandler<Session> remoteSessionOpenEventHandler)
        Sets a EventHandler for when an AMQP Begin frame is received from the remote peer. Used to process remotely initiated Sessions. Locally initiated sessions have their own EventHandler invoked instead. This method is Typically used by servers to listen for remote Session creation.
        Parameters:
        remoteSessionOpenEventHandler - the EventHandler that will be signaled when a session is remotely opened.
        Returns:
        this connection

      • senderOpenHandler

        Connection senderOpenHandler​(EventHandler<Sender> remoteSenderOpenEventHandler)
        Sets a EventHandler for when an AMQP Attach frame is received from the remote peer for a sending link. Used to process remotely initiated sending link. Locally initiated links have their own EventHandler invoked instead. This method is Typically used by servers to listen for remote Receiver creation. If an event handler for remote sender open is registered on the Session that the link is owned by then that handler will be invoked instead of this one.
        Parameters:
        remoteSenderOpenEventHandler - the EventHandler that will be signaled when a sender link is remotely opened.
        Returns:
        this connection

      • receiverOpenHandler

        Connection receiverOpenHandler​(EventHandler<Receiver> remoteReceiverOpenEventHandler)
        Sets a EventHandler for when an AMQP Attach frame is received from the remote peer for a receiving link. Used to process remotely initiated receiving link. Locally initiated links have their own EventHandler invoked instead. This method is Typically used by servers to listen for remote Sender creation. If an event handler for remote receiver open is registered on the Session that the link is owned by then that handler will be invoked instead of this one.
        Parameters:
        remoteReceiverOpenEventHandler - the EventHandler that will be signaled when a receiver link is remotely opened.
        Returns:
        this connection

      • transactionManagerOpenHandler

        Connection transactionManagerOpenHandler​(EventHandler<TransactionManager> remoteTxnManagerOpenEventHandler)
        Sets a EventHandler for when an AMQP Attach frame is received from the remote peer for a transaction coordination link. Used to process remotely initiated transaction manager link. Locally initiated links have their own EventHandler invoked instead. This method is Typically used by servers to listen for remote TransactionController creation. If an event handler for remote TransactionController open is registered on the Session that the link is owned by then that handler will be invoked instead of this one.
        Parameters:
        remoteTxnManagerOpenEventHandler - the EventHandler that will be signaled when a TransactionController link is remotely opened.
        Returns:
        this connection