ptserver.data.handler

Class CommunicationTokenHandler

java.lang.Object

ptserver.data.handler.CommunicationTokenHandler

All Implemented Interfaces:

TokenHandler<CommunicationToken>

public class CommunicationTokenHandler
extends java.lang.Object
implements TokenHandler<CommunicationToken>

Serialize a CommunicationToken to and from binary format.

The stream has the following format: CommunicationToken = Type(2), CommunicationTokenValueField
CommunicationTokenValueField = TargetActorName, PortCount(2), PortData... (PortData is repeated PortCount times)
PortData = PortName, ChannelCount(2), ChannelData... (ChannelData is repeated ChannelCount times)
ChannelData = ChannelTokenCount(2), Token... (Token is repeated ChannelTokenCount times; Its serialized using TokenHandler defined for its data type)

Since:

Ptolemy II 10.0

Version:

$Id: CommunicationTokenHandler.java 70402 2014-10-23 00:52:20Z cxh $

Author:

Anar Huseynov

Accepted Rating:

Red (ahuseyno)

Proposed Rating:

Red (ahuseyno)

Constructor Summary

Constructors

Constructor and Description
CommunicationTokenHandler()

Method Summary

Modifier and Type	Method and Description
void	convertToBytes(CommunicationToken token, java.io.DataOutputStream outputStream) Serialize the communication token to the binary according to the format defined in CommunicationTokenHandler.
CommunicationToken	convertToToken(java.io.DataInputStream inputStream, java.lang.Class<? extends CommunicationToken> tokenType) Deserialize the token from the stream according to the format defined in CommunicationTokenHandler.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommunicationTokenHandler

public CommunicationTokenHandler()

Method Detail

convertToBytes

public void convertToBytes(CommunicationToken token,
                           java.io.DataOutputStream outputStream)
                    throws java.io.IOException,
                           IllegalActionException

Serialize the communication token to the binary according to the format defined in CommunicationTokenHandler.

Specified by:

convertToBytes in interface TokenHandler<CommunicationToken>

Parameters:

token - Token to be converted to bytes.

outputStream - The stream to write to.

Throws:

java.io.IOException - if there is a problem with the outputStream

IllegalActionException - if there is the state becomes inconsistent

See Also:

TokenHandler.convertToBytes(ptolemy.data.Token, java.io.DataOutputStream)

convertToToken

public CommunicationToken convertToToken(java.io.DataInputStream inputStream,
                                         java.lang.Class<? extends CommunicationToken> tokenType)
                                  throws java.io.IOException,
                                         IllegalActionException

Deserialize the token from the stream according to the format defined in CommunicationTokenHandler.

Specified by:

convertToToken in interface TokenHandler<CommunicationToken>

Parameters:

inputStream - The stream to read from.

tokenType - The type of token to be parsed.

Returns:

CommunicationToken deserialized from the inputStream.

Throws:

java.io.IOException - If the stream cannot be read.

IllegalActionException - Not thrown in this class.

See Also:

TokenHandler.convertToToken(java.io.DataInputStream, Class)