|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecteneter.messaging.messagingsystems.connectionprotocols.EneterProtocolFormatter
public class EneterProtocolFormatter
Default Eneter encoding/decoding.
This is the default protocol formatter which can be used in all types of communication.
Here is how this formatter encodes messages between channels:
Open connection message:
6 bytes - header: ENETER
1 byte - endianess: 10 little endian, 20 big endian
1 byte - string encoding: 10 UTF8, 20 UTF16
1 byte - message type: 10 for open connection
4 bytes - length: 32 bit integer indicating the size (in bytes) of the following string
x bytes - responseReceiverId: client id string
Close connection message:
6 bytes - header: ENETER
1 byte - endianess: 10 little endian, 20 big endian
1 byte - string encoding: 10 UTF8, 20 UTF16
1 byte - message type: 20 for close connection
4 bytes - length: 32 bit integer indicating the size (in bytes) of the following string
x bytes - responseReceiverId: client id string
Data message:
6 bytes - header: ENETER
1 byte - endianess: 10 little endian, 20 big endian
1 byte - string encoding: 10 UTF8, 20 UTF16
1 byte - message type: 40 for data message
4 bytes - length: 32 bit integer indicating the size (in bytes) of the following string
x bytes - responseReceiverId: client id string
1 byte - message data type: 10 bytes, 20 string
4 bytes - length: 32 bit integer indicating the size (in bytes) of the following data.
y bytes - message data: message data
Constructor Summary | |
---|---|
EneterProtocolFormatter()
|
Method Summary | |
---|---|
ProtocolMessage |
decodeMessage(java.io.InputStream readStream)
Decodes message from the stream. |
ProtocolMessage |
decodeMessage(java.lang.Object readMessage)
Decodes message from the given object. |
java.lang.Object |
encodeCloseConnectionMessage(java.lang.String responseReceiverId)
Encodes the close connection request message. |
void |
encodeCloseConnectionMessage(java.lang.String responseReceiverId,
java.io.OutputStream outputSream)
Encodes the close connection request message to the stream. |
java.lang.Object |
encodeMessage(java.lang.String responseReceiverId,
java.lang.Object message)
Encodes the data message. |
void |
encodeMessage(java.lang.String responseReceiverId,
java.lang.Object message,
java.io.OutputStream outputSream)
Encodes the data message into the stream. |
java.lang.Object |
encodeOpenConnectionMessage(java.lang.String responseReceiverId)
Encodes the open connection request message. |
void |
encodeOpenConnectionMessage(java.lang.String responseReceiverId,
java.io.OutputStream outputSream)
Encodes the open connection request message to the stream. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EneterProtocolFormatter()
Method Detail |
---|
public java.lang.Object encodeOpenConnectionMessage(java.lang.String responseReceiverId) throws java.lang.Exception
IProtocolFormatter
encodeOpenConnectionMessage
in interface IProtocolFormatter
responseReceiverId
- id of the client opening the connection.
java.lang.Exception
public void encodeOpenConnectionMessage(java.lang.String responseReceiverId, java.io.OutputStream outputSream) throws java.lang.Exception
IProtocolFormatter
encodeOpenConnectionMessage
in interface IProtocolFormatter
responseReceiverId
- id of the client opening the connection.outputSream
- output where the encoded open connection message is written
java.lang.Exception
public java.lang.Object encodeCloseConnectionMessage(java.lang.String responseReceiverId) throws java.lang.Exception
IProtocolFormatter
encodeCloseConnectionMessage
in interface IProtocolFormatter
responseReceiverId
- id of the client that wants to disconnect or that will be disconnected
java.lang.Exception
public void encodeCloseConnectionMessage(java.lang.String responseReceiverId, java.io.OutputStream outputSream) throws java.lang.Exception
IProtocolFormatter
encodeCloseConnectionMessage
in interface IProtocolFormatter
responseReceiverId
- id of the client that wants to disconnect or that will be disconnectedoutputSream
- output where the encoded close connection message is written
java.lang.Exception
public java.lang.Object encodeMessage(java.lang.String responseReceiverId, java.lang.Object message) throws java.lang.Exception
IProtocolFormatter
encodeMessage
in interface IProtocolFormatter
responseReceiverId
- client id.message
- serialized message to be sent.
java.lang.Exception
public void encodeMessage(java.lang.String responseReceiverId, java.lang.Object message, java.io.OutputStream outputSream) throws java.lang.Exception
IProtocolFormatter
encodeMessage
in interface IProtocolFormatter
responseReceiverId
- id of the client that wants to send the message.message
- serialized message to be sent.outputSream
- output where the encoded message is written
java.lang.Exception
public ProtocolMessage decodeMessage(java.io.InputStream readStream)
IProtocolFormatter
decodeMessage
in interface IProtocolFormatter
readStream
- stream to be read
public ProtocolMessage decodeMessage(java.lang.Object readMessage)
IProtocolFormatter
decodeMessage
in interface IProtocolFormatter
readMessage
- reference to the object.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |