Class FrameConnection
java.lang.Object
org.simpleframework.http.socket.service.FrameConnection
- All Implemented Interfaces:
FrameChannel
The
FrameConnection
represents a connection that can
send and receivd WebSocket frames. Any instance of this will provide
a means to perform asynchronous writes and reads to a remote client
using a lightweight framing protocol. A frame is a finite length
sequence of bytes that can hold either text or binary data. Also,
control frames are used to perform heartbeat monitoring and closure.
For convenience frames can be consumed from the socket via a callback to a registered listener. This avoids having to poll each socket for data and provides a asynchronous event driven model of communication, which greatly reduces overhead and complication.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Channel
This is the underlying TCP channel that frames are sent over.private final FrameEncoder
This encoder is used to encode data as RFC 6455 frames.private final FrameCollector
The collector is used to collect frames from the TCP channel.private final Reason
The reason that is sent if at any time the channel is closed.private final Session
This is the session object that has a synchronized channel.private final Trace
This is used to trace all events that occur on the channel.private final ByteWriter
This is the sender used to send frames over the channel. -
Constructor Summary
ConstructorsConstructorDescriptionFrameConnection
(Request request, Response response, Reactor reactor) Constructor for theFrameConnection
object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
This is used to close the connection without a specific reason.void
This is used to close the connection with a specific reason.open()
This is used to open the channel and begin consuming frames.void
register
(FrameListener listener) This is used to register aFrameListener
to this instance.void
remove
(FrameListener listener) This is used to remove aFrameListener
from this instance.void
send
(byte[] data) This is used to send data to the connected client.void
This is used to send text to the connected client.void
This is used to send data to the connected client.
-
Field Details
-
operation
The collector is used to collect frames from the TCP channel. -
encoder
This encoder is used to encode data as RFC 6455 frames. -
writer
This is the sender used to send frames over the channel. -
session
This is the session object that has a synchronized channel. -
channel
This is the underlying TCP channel that frames are sent over. -
reason
The reason that is sent if at any time the channel is closed. -
trace
This is used to trace all events that occur on the channel.
-
-
Constructor Details
-
FrameConnection
Constructor for theFrameConnection
object. This is used to create a channel that can read and write frames over a TCP channel. For asynchronous read and dispatch operations this will produce an operation to collect and process RFC 6455 frames.- Parameters:
request
- this is the initiating request for the WebSocketresponse
- this is the initiating response for the WebSocketreactor
- this is the reactor used to process frames
-
-
Method Details
-
open
This is used to open the channel and begin consuming frames. This will also return the session that contains the details for the created WebSocket such as the initiating request and response as well as theFrameChannel
object.- Returns:
- the session associated with the WebSocket
- Throws:
IOException
-
register
This is used to register aFrameListener
to this instance. The registered listener will receive all user frames and control frames sent from the client. Also, when the frame is closed or when an unexpected error occurs the listener is notified. Any number of listeners can be registered at any time.- Specified by:
register
in interfaceFrameChannel
- Parameters:
listener
- this is the listener that is to be registered- Throws:
IOException
-
remove
This is used to remove aFrameListener
from this instance. After removal the listener will no longer receive any user frames or control messages from this specific instance.- Specified by:
remove
in interfaceFrameChannel
- Parameters:
listener
- this is the listener to be removed- Throws:
IOException
-
send
This is used to send data to the connected client. To prevent an application code from causing resource issues this will block as soon as a configured linked list of mapped memory buffers has been exhausted. Caution should be taken when writing a broadcast implementation that can write to multiple sockets as a badly behaving socket that has filled its output buffering capacity can cause congestion.- Specified by:
send
in interfaceFrameChannel
- Parameters:
data
- this is the data that is to be sent- Throws:
IOException
-
send
This is used to send text to the connected client. To prevent an application code from causing resource issues this will block as soon as a configured linked list of mapped memory buffers has been exhausted. Caution should be taken when writing a broadcast implementation that can write to multiple sockets as a badly behaving socket that has filled its output buffering capacity can cause congestion.- Specified by:
send
in interfaceFrameChannel
- Parameters:
text
- this is the text that is to be sent- Throws:
IOException
-
send
This is used to send data to the connected client. To prevent an application code from causing resource issues this will block as soon as a configured linked list of mapped memory buffers has been exhausted. Caution should be taken when writing a broadcast implementation that can write to multiple sockets as a badly behaving socket that has filled its output buffering capacity can cause congestion.- Specified by:
send
in interfaceFrameChannel
- Parameters:
frame
- this is the frame that is to be sent- Throws:
IOException
-
close
This is used to close the connection with a specific reason. The close reason will be sent as a control frame before the TCP connection is terminated.- Specified by:
close
in interfaceFrameChannel
- Parameters:
reason
- the reason for closing the connection- Throws:
IOException
-
close
This is used to close the connection without a specific reason. The close reason will be sent as a control frame before the TCP connection is terminated.- Specified by:
close
in interfaceFrameChannel
- Throws:
IOException
-