org.softamis.net.multicast
Class Datagram

java.lang.Object
  org.softamis.net.multicast.Datagram

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class Datagram
extends java.lang.Object
implements java.io.Externalizable

Datagram which is sent/received by multicaster as part of UDP communication. Datagram represents actual envelope for application data sent within it. Datagram sent over network in serialized form.

Author:

Andrew Sazonov

See Also:

Multicaster, Serialized Form

Field Summary

protected java.lang.String	fCustomData Payload data carried by datagram
protected java.lang.String	fFrom Sender address
protected java.lang.String	fSignature Signature of message used by multicaster to select own messages
protected java.lang.String	fTo Recipient address
protected byte	fType Type of message (i.e.
static byte	TYPE_REQUEST Datagram is request
static byte	TYPE_RESPONSE Datagram is response

Constructor Summary

Datagram()

Datagram(java.lang.String aSignature)
Creates datagram with given signature.

Method Summary

java.lang.String	getCustomData()
java.lang.String	getFrom()
java.lang.String	getSignature()
java.lang.String	getTo()
byte	getType() Returns type fo datagaram
void	readExternal(java.io.ObjectInput aObjectInput)
protected java.lang.String	readString(java.io.ObjectInput aObjectInput)
void	setCustomData(java.lang.String aCustomData)
void	setFrom(java.lang.String aFrom)
void	setTo(java.lang.String aTo)
void	setType(byte aType)
void	writeExternal(java.io.ObjectOutput aObjectOutput)

Methods inherited from class java.lang.Object

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

Field Detail

fType

protected byte fType

Type of message (i.e. request or response)

fTo

protected java.lang.String fTo

Recipient address

fFrom

protected java.lang.String fFrom

Sender address

fCustomData

protected java.lang.String fCustomData

Payload data carried by datagram

fSignature

protected java.lang.String fSignature

Signature of message used by multicaster to select own messages

TYPE_REQUEST

public static final byte TYPE_REQUEST

Datagram is request

See Also:

Constant Field Values

TYPE_RESPONSE

public static final byte TYPE_RESPONSE

Datagram is response

See Also:

Constant Field Values

Constructor Detail

Datagram

public Datagram(java.lang.String aSignature)

Creates datagram with given signature. Signature is used to filter specific packages from other data that can be sent within the same UDP group

Parameters:

aSignature - signature of datagram

Datagram

public Datagram()

Method Detail

getType

public byte getType()

Returns type fo datagaram

Returns:

setType

public void setType(byte aType)

setFrom

public void setFrom(java.lang.String aFrom)

getFrom

public java.lang.String getFrom()

setTo

public void setTo(java.lang.String aTo)

getTo

public java.lang.String getTo()

setCustomData

public void setCustomData(java.lang.String aCustomData)

getCustomData

public java.lang.String getCustomData()

getSignature

public java.lang.String getSignature()

writeExternal

public void writeExternal(java.io.ObjectOutput aObjectOutput)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput aObjectInput)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

readString

protected java.lang.String readString(java.io.ObjectInput aObjectInput)
                               throws java.io.IOException

Throws:

java.io.IOException