AMPS.Client.NVFIXBuilder Class Reference

Used to build up message strings for NVFIX. More...

Public Member Functions
	NVFIXBuilder (int capacity, byte fieldSeparator)
int	getSize ()
	Returns the number of bytes in the array containing the NVFIX message. More...
byte[]	getBytes ()
	Returns the byte array containing the NVFIX message. The number of valid bytes within the buffer is returned from getSize(). More...
NVFIXBuilder	append (String tag, byte[] value, int offset, int length)
	Appends a tag and and value pair contained within a byte buffer to the NVFIX message. More...
NVFIXBuilder	append (String tag, String value)
	Appends a tag and value pair to the NVFIX message. More...
NVFIXBuilder	clear ()
	Clears the current buffer in the Builder so it can be reused. Capacity is unaffected. More...

Detailed Description

Used to build up message strings for NVFIX.

Member Function Documentation

append() [1/2]

NVFIXBuilder AMPS.Client.NVFIXBuilder.append ( String  tag, byte[]  value, int  offset, int  length  )

inline

Appends a tag and and value pair contained within a byte buffer to the NVFIX message.

Parameters

tag	The NVFIX tag to append
value	The byte buffer containing the NVFIX value to append
offset	The starting location of the value inside the byte buffer
length	The length of the value inside the byte buffer

Returns

A reference to this object

Exceptions

CommandException

Thrown if tag cannot be converted to ISO-8859-1.

append() [2/2]

NVFIXBuilder AMPS.Client.NVFIXBuilder.append ( String  tag, String  value  )

inline

Appends a tag and value pair to the NVFIX message.

Parameters

tag	the NVFIX tag to append
value	the NVFIX value for the tag to append. The value will be converted to an ISO-8859-1 byte array for writing.

Returns

a reference to this object.

Exceptions

CommandException

If the tag or value argument is not convertible to ISO-8859-1

clear()

NVFIXBuilder AMPS.Client.NVFIXBuilder.clear ( )

inline

Clears the current buffer in the Builder so it can be reused. Capacity is unaffected.

Returns

a reference to this object.

getBytes()

byte [] AMPS.Client.NVFIXBuilder.getBytes ( )

inline

Returns the byte array containing the NVFIX message. The number of valid bytes within the buffer is returned from getSize().

Returns

The byte array containing the NVFIX message.

getSize()

int AMPS.Client.NVFIXBuilder.getSize ( )

inline

Returns the number of bytes in the array containing the NVFIX message.

Returns

The number of valid bytes in teh byte array.

---

The documentation for this class was generated from the following file:

• AMPS.Client/NVFIXBuilder.cs