CADI.Common.Network.JPIP
Class ServerControlField

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

All Implemented Interfaces:

ImageReturnTypes

public class ServerControlField
extends java.lang.Object
implements ImageReturnTypes

This class is used to store the server control fields.

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

Version:

beta 0.1 2007/10/26

Author:

Group on Interactive Coding of Images (GICI)

Field Summary

boolean	align align = "align" "=" ("yes" / "no") This field specifies whether the server response data shall be aligned on natural boundaries.
float	drate drate = "drate" "=" rate-factor rate-factor = UFLOAT This field is used to specify the delivery rate of various codestreams.
java.util.ArrayList<java.lang.String>	type type = "type" "=" 1#image-return-type image-return-type = media-type / reserved-image-return-type media-type = TOKEN "/" TOKEN *( ";" parameter ) reserved-image-return-type = TOKEN *( ";" parameter ) parameter = attribute "=" value attribute = TOKEN value = TOKEN This field is used to indicate the type (or types) of the requested response data.
boolean	wait wait = "wait" "=" ("yes" / "no") This field is used to indicate whether the server shall complete a response to the previous request.

Fields inherited from interface CADI.Common.Defaults.ImageReturnTypes

JPP_STREAM, JPT_STREAM, MAX_IMAGE_RETURN_TYPES_ALLOWED, RAW

Constructor Summary

ServerControlField()
Constructor.

Method Summary

void	list(java.io.PrintStream out) Prints this Server Control 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

align

public boolean align

align = "align" "=" ("yes" / "no")

This field specifies whether the server response data shall be aligned on natural boundaries. The default value is "no". If the value is "yes", any JPT-stream or JPP-stream message delivered in response to this request which crosses any "natural boundary" shall terminate at any subsequent "natural boundary." The natural boundaries for each data-bin type are listed in the below table. A message is said to cross a natural boundary if it includes the last byte prior to the boundary, and the first byte after the boundary. For example, a precinct data-bin crosses a natural boundary if it includes the last byte of one packet and the first byte of the next packet. Note carefully that aligned response messages are not actually required to terminate at a natural boundary unless they cross a boundary. This means, for example, that the response may include partial packets from precincts, which may be necessary if a prevailing byte limit prevents the delivery of complete packets.

Bin type	Natural boundary
Precinct data-bin	End of a packet (one boundary for each quality layer)
Tile data-bin	End of a tile-part (one boundary for each tile-part)
Tile header data-bin	End of the bin (only one boundary)
Main data-bin	End of the bin (only one boundary)
Metadata-bin	End of a box at the top level of the data-bin (one boundary for each box)

wait

public boolean wait

wait = "wait" "=" ("yes" / "no")

This field is used to indicate whether the server shall complete a response to the previous request. If the value of the field is "yes", the server shall completely respond to the previous request on the same channel resource specified through the channel ID field before starting to respond to this request. If the value of this field is "no", the server may gracefully terminate the processing of any previous request on the same channel resource (specified through the Channel ID field) prior to completion and may start to respond to this new request. In this context, "graceful termination" implies that the server shall at least complete the current message. The default value of this field is "no"

type

public java.util.ArrayList<java.lang.String> type

type = "type" "=" 1#image-return-type
image-return-type = media-type / reserved-image-return-type
media-type = TOKEN "/" TOKEN *( ";" parameter )
reserved-image-return-type = TOKEN *( ";" parameter )
parameter = attribute "=" value
attribute = TOKEN
value = TOKEN

This field is used to indicate the type (or types) of the requested response data. A server unwilling to provide any of the requested return types shall issue an error response.

The value of the Image Return Type request field shall be either a media type (defined in RFC 2046) or one of the reserved image return types defined as:

Type	Interpretation
"jpp-stream"	A JPP-stream as defined in Annex A. "jpp-stream" may optionally be followed by ";ptype=ext", in which case the requested return type is one in which all precinct databin message headers have the extended form. (see A.2.2)
"jpt-stream"	A JPT-stream as defined in Annex A. "jpt-stream" may optionally be followed by ";ttype=ext", in which case the requested return type is one in which all tile data-bin message headers have the extended form. (see A.2.2)
"raw"	The client is requesting the entire sequence of bytes in the logical target to be delivered unchanged.
Other values	Reserved for ISO use

drate

public float drate

drate = "drate" "=" rate-factor
rate-factor = UFLOAT

This field is used to specify the delivery rate of various codestreams. If this field is supplied, the server shall deliver data belonging to the various codestreams in the view-window following a temporally sequenced schedule. The codestreams which belong to the view-window are all those identified via the Codestream request field and the Codestream Context request field, possibly subsampled in accordance with the Sampling Rate request field.

Constructor Detail

ServerControlField

public ServerControlField()

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 Server Control Fields out to the specified output stream. This method is useful for debugging.

Parameters:

out - an output stream.