org.jboss.as.process.protocol

Interface Connection

All Superinterfaces:

AutoCloseable, Closeable

public interface Connection
extends Closeable

A peer-to-peer connection with another participant in the management protocol.

Author:

David M. Lloyd

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Connection.ClosedCallback A callback that will be triggered once the connection is closed

Method Summary

Modifier and Type	Method and Description
void	attach(Object attachment)
void	backupMessageHandler() Records the current message handler, which can be reset using restoreMessageHandler()
void	close() Close the connection.
Object	getAttachment()
InetAddress	getPeerAddress() Get the remote peer address.
void	restoreMessageHandler() Resets the message handler to any that was backed up using backupMessageHandler().
void	setMessageHandler(MessageHandler messageHandler) Change the current message handler.
void	shutdownWrites() Shut down writes once all messages are sent.
OutputStream	writeMessage() Write a protocol message.

Method Detail

writeMessage

OutputStream writeMessage()
                   throws IOException

Write a protocol message. Returns a stream which can be written to, to transmit the data. When the stream is closed, the message is concluded.

Returns:

the stream to which the message should be written

Throws:

IOException - if an I/O error occurs

shutdownWrites

void shutdownWrites()
             throws IOException

Shut down writes once all messages are sent. This will cause the reading side's MessageHandler.handleShutdown(Connection) method to be called.

Throws:

IOException - if an I/O error occurs

close

void close()
    throws IOException

Close the connection. This will interrupt both reads and writes and so should only be done in the event of an unrecoverable failure of the connection.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if the close fails

setMessageHandler

void setMessageHandler(MessageHandler messageHandler)

Change the current message handler.

Parameters:

messageHandler - the new message handler to use

getPeerAddress

InetAddress getPeerAddress()

Get the remote peer address.

Returns:

the peer address

attach

void attach(Object attachment)

getAttachment

Object getAttachment()

backupMessageHandler

void backupMessageHandler()

Records the current message handler, which can be reset using restoreMessageHandler()

restoreMessageHandler

void restoreMessageHandler()

Resets the message handler to any that was backed up using backupMessageHandler(). If no backup was done, MessageHandler.NULL is used