CADI.Common.Network.JPIP
Class ChannelField

java.lang.Object
  CADI.Common.Network.JPIP.ChannelField

public class ChannelField
extends java.lang.Object

This class is used to store the channel fields.

Further information, see ISO/IEC 15444-9 section C.3

Version:

1.0 2008/02/21

Author:

Group on Interactive Coding of Images (GICI)

Field Summary

java.lang.String[]	cclose cclose = "cclose" "=" ("*" / 1#channel-id) This field is used to close one or more open channels to a session.
static int	CHANNEL_HTTP Allowed values for the cnew attribute.
static int	CHANNEL_HTTP_TCP
java.lang.String	cid cid = "cid" "=" channel-id channel-id = TOKEN This field is used to associate the request with a particular JPIP channel, and hence the session to which the channel belongs.
int[]	cnew cnew = "cnew" "=" 1#transport-name transport-name = TOKEN This field is used to request a new JPIP channel.
java.lang.String	path Definition in JPIPResponseFields.path
int	qid qid = "qid" "=" UINT This field is used to specify a Request ID value.

Constructor Summary

ChannelField()
Constructor.

Method Summary

void	list(java.io.PrintStream out) Prints this Channel fields out to the specified output stream.
void	reset() Sets the attributes to its initial values.
java.lang.String	toString() For debugging purposes.

Methods inherited from class java.lang.Object

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

Field Detail

cid

public java.lang.String cid

cid = "cid" "=" channel-id
channel-id = TOKEN

This field is used to associate the request with a particular JPIP channel, and hence the session to which the channel belongs.

path

public java.lang.String path

Definition in JPIPResponseFields.path

cnew

public int[] cnew

cnew = "cnew" "=" 1#transport-name
transport-name = TOKEN

This field is used to request a new JPIP channel. If no Channel ID request field is present, the request is for a new session. Otherwise, the request is for a new channel in the same session as the channel identified by the Channel ID request field.

The value string identifies the names of one or more transport protocols that the client is willing to accept. The ISO/IEC 15444-9:2005 Recommendation | International Standard defines only the transport names, "http" and "http-tcp," although it is anticipated that other transports, such as "udp", may be defined elsewhere.

CHANNEL_HTTP

public static final int CHANNEL_HTTP

Allowed values for the cnew attribute.

See Also:

Constant Field Values

CHANNEL_HTTP_TCP

public static final int CHANNEL_HTTP_TCP

See Also:

Constant Field Values

cclose

public java.lang.String[] cclose

cclose = "cclose" "=" ("*" / 1#channel-id)

This field is used to close one or more open channels to a session. If the value field contains one or more channel-id tokens, they shall all belong to the same session. In this case, the Channel ID request field is not necessary, but if provided it shall also reference a channel belonging to the same session. If the value field is "*", all channels associated with the session will be closed. In this case, the session shall be identified by the inclusion of a Channel ID request field.

qid

public int qid

qid = "qid" "=" UINT

This field is used to specify a Request ID value. Each channel has its own request queue, with its own Request ID counter. Requests which are received within any given channel (as indicated by the Channel ID value) shall be processed in the order of their Request ID values, where the Request ID field is used. The server may process requests which do not contain a Request ID field on a first-come-first-served basis. However, it shall not process a request which carrives with a Request ID value of n until it has processed all requests with a Request ID value less than n which is associated with the same channel, unless n=0. The client shall not issue a request which specifies the same Request ID value as any other request associated with the same channel, and shall not issue Request ID's that are smaller than any previously issued Request ID on this channel.

Constructor Detail

ChannelField

public ChannelField()

Constructor.

Method Detail

reset

public void reset()

Sets the attributes to its initial values.

toString

public java.lang.String toString()

For debugging purposes.

Overrides:

toString in class java.lang.Object

list

public void list(java.io.PrintStream out)

Prints this Channel fields out to the specified output stream. This method is useful for debugging.

Parameters:

out - an output stream.