Home Corporate Contacts

TETware Java Documentation


All Packages Class Hierarchy This Package Previous Next Index

Class TET.SyncMessage

java.lang.Object
   |
   +----TET.SyncMessage

public class SyncMessage
extends Object
The SyncMessage class provides the details of one message used during a TET sychronization event.


Variable Index

 o TET_SMDUP
Bit value for flags, indicating that more than one system attempted to send message data.
 o TET_SMMSGMAX
Maximum size of a sync message.
 o TET_SMRCVMSG
Bit value for flags, indicating that the system is receiving message data.
 o TET_SMSNDMSG
Bit value for flags, indicating that the system is sending message data.
 o TET_SMTRUNC
Bit value for flags, indicating that the message data was truncated.

Constructor Index

 o SyncMessage()
Construct an empty SyncMessage.
 o SyncMessage(byte[])
Construct a SyncMessage which will be used for the transmission of a message.
 o SyncMessage(int)
Construct a SyncMessage which will be used for the reception of a message.

Method Index

 o duplicated()
Were there two senders during synchronization?
 o getSysID()
Get the value of the system ID of the sending system.
 o length()
Retrieve the message length.
 o message()
Retrieve the message data.
 o sender()
Was this message sent or does it contains message received from another system?
 o set_message(byte[])
Set up a SyncMessage for transmission of a message.
 o set_receive_length(int)
Set up a SyncMessage for reception of a message.
 o truncated()
Was this synchronization message truncated?

Variables

 o TET_SMSNDMSG
 public static final int TET_SMSNDMSG
Bit value for flags, indicating that the system is sending message data.

Provided as public for backwards compatibility only; serves no useful purpose outside package.

 o TET_SMRCVMSG
 public static final int TET_SMRCVMSG
Bit value for flags, indicating that the system is receiving message data.

Provided as public for backwards compatibility only; serves no useful purpose outside package.

 o TET_SMDUP
 public static final int TET_SMDUP
Bit value for flags, indicating that more than one system attempted to send message data.

Provided as public for backwards compatibility only; serves no useful purpose outside package.

 o TET_SMTRUNC
 public static final int TET_SMTRUNC
Bit value for flags, indicating that the message data was truncated.

Provided as public for backwards compatibility only; serves no useful purpose outside package.

 o TET_SMMSGMAX
 public static final int TET_SMMSGMAX
Maximum size of a sync message. Size must be expressable in 12 bits.

Constructors

 o SyncMessage
 public SyncMessage()
Construct an empty SyncMessage.

 o SyncMessage
 public SyncMessage(byte msg[])
Construct a SyncMessage which will be used for the transmission of a message.

Parameters:
msg - the message to send.
 o SyncMessage
 public SyncMessage(int msglen)
Construct a SyncMessage which will be used for the reception of a message.

Parameters:
msglen - the size of the receive buffer to set up.

Methods

 o set_message
 public void set_message(byte msg[])
Set up a SyncMessage for transmission of a message.

Parameters:
msg - the message to send.
 o length
 public int length()
Retrieve the message length.

Returns:
the message length.
 o set_receive_length
 public void set_receive_length(int msglen)
Set up a SyncMessage for reception of a message.

Parameters:
msglen - the size of the receive buffer to set up.
 o message
 public byte[] message()
Retrieve the message data.

Returns:
the message data (as a byte array), null if there is no message data.
 o truncated
 public boolean truncated()
Was this synchronization message truncated?

Returns:
true if the message was truncated because the message was longer than the receive buffer or because the message was longer than the permitted message length.
 o duplicated
 public boolean duplicated()
Were there two senders during synchronization?

Returns:
true if there were two senders during synchronization.
 o sender
 public boolean sender()
Was this message sent or does it contains message received from another system?

Returns:
true if this message was sent during synchronization.
 o getSysID
 public int getSysID()
Get the value of the system ID of the sending system.

Returns:
the value of the system ID, or -1 if this message data was not used to receive data.

All Packages Class Hierarchy This Package Previous Next Index

Home Contacts Legal Copyright Corporate News

Copyright © The Open Group 1995-2012, All Rights Reserved