All Frameworks Class Hierarchy This Framework Previous Next Indexes
System Interface CATIBBStreamer
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIBBStreamer
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIBBStreamer
Interface to stream and unstream backbone messages.
Role: CATIBBStreamer helps the implementation of the
StreamData and UnstreamData methods of the CATIStreamMsg interface. It provides streaming and unstreaming methods for the main simple data types.
CATIBBStreamer is implemented by the supplied
CATBBMessage component. Since your message component derives from this component, it inherits
the implementation of CATIBBStreamer.
Method Index
- o
BeginStream()
- Initializes a backbone message streaming operation.
- o
BeginUnstream(void*,int)
- Begins a backbone message unstreaming operation.
- o
EndStream(int*)
- Ends a backbone message streaming operation and returns the streamed buffer.
- o
EndUnstream()
- Ends a backbone message unstreaming operation.
- o
ResetStreamData()
- Frees the streamed buffer created by a backbone message streaming operation.
- o
StreamByte(char)
- Streams a char.
- o
StreamDouble(double)
- Streams a double.
- o
StreamFixedByteArray(void*,int)
- Streams a fixed size array of bytes.
- o
StreamFixedDoubleArray(double[],int)
- Streams fixed size array of doubles.
- o
StreamFixedFloatArray(float[],int)
- Streams fixed size array of float.
- o
StreamFixedIntArray(int[],int)
- Streams a fixed size array of int.
- o
StreamFixedShortArray(short[],int)
- Streams a fixed size array of short.
- o
StreamFixedUnsignedArray(unsigned int[],int)
- Streams a fixed size array of unsigned int.
- o
StreamFixedUnsignedShortArray(unsigned short[],int)
- Streams a fixed size array of unsigned short.
- o
StreamFloat(float)
- Streams a float.
- o
StreamInt(int)
- Streams an int.
- o
StreamShort(short)
- Streams a short.
- o
StreamString(char*)
- Streams a string.
- o
StreamUnsigned(unsigned int)
- Streams an unsigned int.
- o
StreamUnsignedShort(unsigned short)
- Streams an unsigned short.
- o
StreamVariableByteArray(void*,int)
- Streams a variable size array of bytes.
- o
StreamVariableDoubleArray(double[],int)
- Streams variable size array of doubles.
- o
StreamVariableFloatArray(float[],int)
- Streams variable size array of float.
- o
StreamVariableIntArray(int[],int)
- Streams a variable size array of int.
- o
StreamVariableShortArray(short[],int)
- Streams a variable size array of short.
- o
StreamVariableUnsignedArray(unsigned int[],int)
- Streams a variable size array of unsigned int.
- o
StreamVariableUnsignedShortArray(unsigned short[],int)
- Streams variable size array of unsigned short.
- o
UnstreamByte(char*)
- Unstreams a char.
- o
UnstreamDouble(double*)
- Unstreams a double.
- o
UnstreamFixedByteArray(void*,int)
- Unstreams a fixed size byte array.
- o
UnstreamFixedDoubleArray(double[],int)
- Unstreams a fixed double array.
- o
UnstreamFixedFloatArray(float[],int)
- Unstreams a fixed float array.
- o
UnstreamFixedIntArray(int[],int)
- Unstreams a fixed int array.
- o
UnstreamFixedShortArray(short[],int)
- Unstreams a fixed short array.
- o
UnstreamFixedUnsignedArray(unsigned[],int)
- Unstreams a fixed size array of unsigned int.
- o
UnstreamFixedUnsignedShortArray(unsigned short[],int)
- Unstreams a fixed unsigned short array.
- o
UnstreamFloat(float*)
- Unstreams a float.
- o
UnstreamInt(int*)
- Unstreams an int.
- o
UnstreamNeededStringLength(int*)
- Unstreams the length of a string.
- o
UnstreamShort(short*)
- Unstreams a short.
- o
UnstreamString(char*)
- Unstreams a string.
- o
UnstreamUnsigned(unsigned int*)
- Unstreams an unsigned int.
- o
UnstreamUnsignedShort(unsigned short*)
- Unstreams an unsigned short.
- o
UnstreamVariableArrayLength(int*)
- Unstreams the size of a variable size array.
Methods
o BeginStream
public virtual HRESULT BeginStream( | )=0 |
-
Initializes a backbone message streaming operation.
Role: Mandatory call at the beginning of a streaming operation.
BeginStream must be called at the beginning of a streaming operation
to set or reset the streamed buffer.
o BeginUnstream
public virtual HRESULT BeginUnstream( | void* | iData, |
| int | iLength)=0 |
-
Begins a backbone message unstreaming operation.
Role: Mandatory call at the beginning of an unstreaming operation.
BeginUnstream must be called at the beginning of an unstreaming operation
to designate the streamed buffer to unstream.
- Parameters:
-
- iData
- The buffer of data to unstream
- iLength
- The length of the buffer to unstream expressed in bytes
o EndStream
public virtual void * EndStream( | int* | oLength)=0 |
-
Ends a backbone message streaming operation and returns the streamed buffer.
Role: Mandatory call at the end of a streaming operation.
EndStream must be called at the end of a streaming operation
to close the streamed buffer and to retrieve it.
- Parameters:
-
- oLength
- The length of the streamed buffer
- Returns:
- The streamed buffer
o EndUnstream
public virtual HRESULT EndUnstream( | )=0 |
-
Ends a backbone message unstreaming operation.
Role: Mandatory call at the end of an unstreaming operation.
o ResetStreamData
public virtual HRESULT ResetStreamData( | )=0 |
-
Frees the streamed buffer created by a backbone message streaming operation.
Role: Once the backbone message is streamed and sent, the buffer
that contains the streamed message becomes of no use and must be freed
using ResetStreamData.
o StreamByte
public virtual HRESULT StreamByte( | char | iVal)=0 |
-
Streams a char.
- Parameters:
-
- iVal
- the char to stream
o StreamDouble
public virtual HRESULT StreamDouble( | double | iDouble)=0 |
-
Streams a double.
- Parameters:
-
- iDouble
- The double to stream
o StreamFixedByteArray
public virtual HRESULT StreamFixedByteArray( | const void* | iTab, |
| int | iLength)=0 |
-
Streams a fixed size array of bytes.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamFixedDoubleArray
public virtual HRESULT StreamFixedDoubleArray( | const double[] | iTab, |
| int | iLength)=0 |
-
Streams fixed size array of doubles.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamFixedFloatArray
public virtual HRESULT StreamFixedFloatArray( | const float[] | iTab, |
| int | iLength)=0 |
-
Streams fixed size array of float.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamFixedIntArray
public virtual HRESULT StreamFixedIntArray( | const int[] | iTab, |
| int | iLength)=0 |
-
Streams a fixed size array of int.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamFixedShortArray
public virtual HRESULT StreamFixedShortArray( | const short[] | iTab, |
| int | iLength)=0 |
-
Streams a fixed size array of short.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamFixedUnsignedArray
public virtual HRESULT StreamFixedUnsignedArray( | const unsigned int[] | iTab, |
| int | iLength)=0 |
-
Streams a fixed size array of unsigned int.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamFixedUnsignedShortArray
public virtual HRESULT StreamFixedUnsignedShortArray( | const unsigned short[] | iTab, |
| int | iLength)=0 |
-
Streams a fixed size array of unsigned short.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamFloat
public virtual HRESULT StreamFloat( | float | iFloat)=0 |
-
Streams a float.
- Parameters:
-
- iFloat
- The float to stream
o StreamInt
public virtual HRESULT StreamInt( | int | iInt)=0 |
-
Streams an int.
- Parameters:
-
- iInt
- The int to stream
o StreamShort
public virtual HRESULT StreamShort( | short | iVal)=0 |
-
Streams a short.
- Parameters:
-
- iShort
- The short to stream
o StreamString
public virtual HRESULT StreamString( | const char* | iString)=0 |
-
Streams a string.
- Parameters:
-
- iString
- The string to stream
o StreamUnsigned
public virtual HRESULT StreamUnsigned( | unsigned int | iUnsignedInt)=0 |
-
Streams an unsigned int.
- Parameters:
-
- iUnsignedInt
- The unsigned int to stream
o StreamUnsignedShort
public virtual HRESULT StreamUnsignedShort( | unsigned short | iVal)=0 |
-
Streams an unsigned short.
- Parameters:
-
- iUnsignedShort
- The unsigned short to stream
o StreamVariableByteArray
public virtual HRESULT StreamVariableByteArray( | const void* | iTab, |
| int | iLength)=0 |
-
Streams a variable size array of bytes.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamVariableDoubleArray
public virtual HRESULT StreamVariableDoubleArray( | const double[] | iTab, |
| int | iLength)=0 |
-
Streams variable size array of doubles.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamVariableFloatArray
public virtual HRESULT StreamVariableFloatArray( | const float[] | iTab, |
| int | iLength)=0 |
-
Streams variable size array of float.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamVariableIntArray
public virtual HRESULT StreamVariableIntArray( | const int[] | iTab, |
| int | iLength)=0 |
-
Streams a variable size array of int.
- Parameters:
-
- iTab
- The array of int to stream
- iLength
- The size of the array to stream
o StreamVariableShortArray
public virtual HRESULT StreamVariableShortArray( | const short[] | iTab, |
| int | iLength)=0 |
-
Streams a variable size array of short.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamVariableUnsignedArray
public virtual HRESULT StreamVariableUnsignedArray( | const unsigned int[] | iTab, |
| int | iLength)=0 |
-
Streams a variable size array of unsigned int.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamVariableUnsignedShortArray
public virtual HRESULT StreamVariableUnsignedShortArray( | const unsigned short[] | iTab, |
| int | iLength)=0 |
-
Streams variable size array of unsigned short.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o UnstreamByte
public virtual HRESULT UnstreamByte( | char* | oChar)=0 |
-
Unstreams a char.
- Parameters:
-
- oChar
- The unstreamed char
o UnstreamDouble
public virtual HRESULT UnstreamDouble( | double* | oDouble)=0 |
-
Unstreams a double.
- Parameters:
-
- oDouble
- The unstreamed double
o UnstreamFixedByteArray
public virtual HRESULT UnstreamFixedByteArray( | void* | oByteArray, |
| int | iLength)=0 |
-
Unstreams a fixed size byte array.
- Parameters:
-
- oByteArray
- The unstreamed array
- iLength
- The length of the fixed size array
o UnstreamFixedDoubleArray
public virtual HRESULT UnstreamFixedDoubleArray( | double[] | iTab, |
| int | iLength)=0 |
-
Unstreams a fixed double array.
- Parameters:
-
- iTab
- The array to fill with doubles
- iLength
- The length of the fixed size array (or obtained using
UnstreamVariableArrayLength )
o UnstreamFixedFloatArray
public virtual HRESULT UnstreamFixedFloatArray( | float[] | iTab, |
| int | iLength)=0 |
-
Unstreams a fixed float array.
- Parameters:
-
- iTab
- The array to fill with floats
- iLength
- The length of the fixed size array (or obtained using
UnstreamVariableArrayLength )
o UnstreamFixedIntArray
public virtual HRESULT UnstreamFixedIntArray( | int[] | iTab, |
| int | iLength) =0 |
-
Unstreams a fixed int array.
- Parameters:
-
- iTab
- The array to fill with ints
- iLength
- The length of the fixed size array (or obtained using
UnstreamVariableArrayLength )
o UnstreamFixedShortArray
public virtual HRESULT UnstreamFixedShortArray( | short[] | iTab, |
| int | iLength)=0 |
-
Unstreams a fixed short array.
- Parameters:
-
- iTab
- The array to fill with shorts
- iLength
- The length of the fixed size array (or obtained using
UnstreamVariableArrayLength )
o UnstreamFixedUnsignedArray
public virtual HRESULT UnstreamFixedUnsignedArray( | unsigned[] | iTab, |
| int | iLength)=0 |
-
Unstreams a fixed size array of unsigned int.
- Parameters:
-
- iTab
- The array to fill with unsigned ints
- iLength
- The length of the fixed size array (or obtained using
UnstreamVariableArrayLength )
o UnstreamFixedUnsignedShortArray
public virtual HRESULT UnstreamFixedUnsignedShortArray( | unsigned short[] | iTab, |
| int | iLength)=0 |
-
Unstreams a fixed unsigned short array.
- Parameters:
-
- iTab
- The array to fill with unsigned shorts
- iLength
- The length of the fixed size array (or obtained using
UnstreamVariableArrayLength )
o UnstreamFloat
public virtual HRESULT UnstreamFloat( | float* | oFloat)=0 |
-
Unstreams a float.
- Parameters:
-
- oFloat
- The unstreamed float
o UnstreamInt
public virtual HRESULT UnstreamInt( | int* | oInt)=0 |
-
Unstreams an int.
- Parameters:
-
- oInt
- The unstreamed int
o UnstreamNeededStringLength
public virtual HRESULT UnstreamNeededStringLength( | int* | oLength)=0 |
-
Unstreams the length of a string.
- Parameters:
-
- oLength
- The length of the string to unstream
o UnstreamShort
public virtual HRESULT UnstreamShort( | short* | oShort)=0 |
-
Unstreams a short.
- Parameters:
-
- oShort
- The unstreamed short
o UnstreamString
public virtual HRESULT UnstreamString( | char* | oString)=0 |
-
Unstreams a string.
- Parameters:
-
- oString
- The unstreamed string
o UnstreamUnsigned
public virtual HRESULT UnstreamUnsigned( | unsigned int* | oUnsignedInt)=0 |
-
Unstreams an unsigned int.
- Parameters:
-
- oUnsignedInt
- The unstreamed unsigned int
o UnstreamUnsignedShort
public virtual HRESULT UnstreamUnsignedShort( | unsigned short* | oUnsignedShort)=0 |
-
Unstreams an unsigned short.
- Parameters:
-
- oUnsignedShort
- The unstreamed unsigned short
o UnstreamVariableArrayLength
public virtual HRESULT UnstreamVariableArrayLength( | int* | oLength)=0 |
-
Unstreams the size of a variable size array.
Role: A variable size array can be unstreamed as a fixed-size array
as soon as its size is known.
Before calling the appropriate unstreaming method for a fixed-size array (UnstreamFixed(type)Array),
UnstreamVariableArrayLength enables you to retrieve the array size and
to allocate the array accordingly.
- Parameters:
-
- oLength
- The length (number of elements) of the array to unstream.
This object is included in the file: CATIBBStreamer.h
If needed, your Imakefile.mk should include the module: CATSysCommunication