Module com.thecoderscorner.tcmenu.javaapi

Package com.thecoderscorner.menu.remote.protocol

Class TagValMenuCommandProtocol

java.lang.Object

com.thecoderscorner.menu.remote.protocol.TagValMenuCommandProtocol

All Implemented Interfaces:

MenuCommandProtocol

public class TagValMenuCommandProtocol
extends Object
implements MenuCommandProtocol

A protocol implementation that uses tag value pair notation with a few special text items in order to create messages that can be transmitted. It is currently the default protocol. Example of this format: "0=123|1=234~" where key 0 is 123 and key 1 is 234, tilde indicates the end of the message.

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	END_OF_MSG
static final byte	FIELD_TERMINATOR
static final byte	PROTOCOL_TAG_VAL
static final byte	START_OF_MSG

Constructor Summary

Constructors

Constructor	Description
TagValMenuCommandProtocol()

Method Summary

Modifier and Type	Method	Description
MenuCommand	fromChannel(ByteBuffer buffer)	Retrieves a message from the channel, or throws an exception if the message is not fully formed.
byte	getKeyIdentifier()	returns the identifier for this protocol, when used in messages
void	toChannel(ByteBuffer buffer, MenuCommand cmd)	Puts the command specified into the byte buffer, it is assumed that the callee will flip the channel once complete.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PROTOCOL_TAG_VAL

public static final byte PROTOCOL_TAG_VAL

See Also:

• Constant Field Values

START_OF_MSG

public static final byte START_OF_MSG

See Also:

• Constant Field Values

END_OF_MSG

public static final byte END_OF_MSG

See Also:

• Constant Field Values

FIELD_TERMINATOR

public static final byte FIELD_TERMINATOR

See Also:

• Constant Field Values

Constructor Details

TagValMenuCommandProtocol

public TagValMenuCommandProtocol()

Method Details

fromChannel

public MenuCommand fromChannel(ByteBuffer buffer)
                        throws IOException

Description copied from interface: MenuCommandProtocol

Retrieves a message from the channel, or throws an exception if the message is not fully formed. It is assumed that the buffer has been suitably flipped ready for reading

Specified by:

fromChannel in interface MenuCommandProtocol

Throws:

IOException

toChannel

public void toChannel(ByteBuffer buffer,
 MenuCommand cmd)

Description copied from interface: MenuCommandProtocol

Puts the command specified into the byte buffer, it is assumed that the callee will flip the channel once complete.

Specified by:

toChannel in interface MenuCommandProtocol

Parameters:

buffer - to write the data to

cmd - the command to write

getKeyIdentifier

public byte getKeyIdentifier()

Description copied from interface: MenuCommandProtocol

returns the identifier for this protocol, when used in messages

Specified by:

getKeyIdentifier in interface MenuCommandProtocol

Returns:

the ID for this protocol