IStreamContainer Interface

Solclient

version: 7.2.1.27

Represents a structured data types (SDT) stream container.

Namespace: SolaceSystems.Solclient.Messaging.SDT
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 7.2.1.27 (7.2.1.27)

Syntax

C++

Copy

public interface IStreamContainer : ISDTContainer, 
	IDisposable

Public Interface IStreamContainer
	Inherits ISDTContainer, IDisposable

public interface class IStreamContainer : ISDTContainer, 
	IDisposable

The IStreamContainer type exposes the following members.

Methods

	Name	Description
	AddBool	Adds a bool field to the stream.
	AddByteArray	Adds a byte array field to the stream.
	AddChar	Adds a char field to the stream.
	AddDestination	Adds a IDestination field to the stream.
	AddDouble	Adds a double field to the stream.
	AddFloat	Adds a float field to the stream.
	AddInt16	Adds a Int16 field to the stream.
	AddInt32	Adds a Int32 field to the stream.
	AddInt64	Adds a Int64 field to the stream.
	AddInt8	Adds an Int8 field to the stream.
	AddNull	Adds a null (NULL) field to the stream.
	AddSDTContainer	Adds a ISDTContainer field to this stream container.
	AddSmfMsg	Adds a ISmfMessage field to the stream.
	AddString	Adds a string field to the stream.
	AddUInt16	Adds a UInt16 field to the stream.
	AddUInt32	Adds a UInt32 field to the stream.
	AddUInt64	Adds a UInt64 field to the stream.
	AddUInt8	Adds a UInt8 field to the stream.
	AddUnknownField	Adds a IUnknownSDTField field to the stream.
	Close	Closes the ISDTContainer, making it unusable for read or write operations. It is an error to invoke this method in the following cases (An OperationErrorException will be thrown): The IMessage holding this container is already sent (after calling Send(IMessage)). The ISDTContainer holding this container is already closed (after calling Close). (Inherited from ISDTContainer.)
	CreateMap	Creates a sub-map with the given name. The returned IMapContainer is is ready for read and write operations. It is recommended to Close the IMapContainer when done. If it is not explicitly closed, the container is automatically closed when the associated parent container is closed or the associated message (if it is a message-dependent container) is disposed. Whether it is explicitly closed by the client application, or implicitly by the API, any attempt to use this container will result in an OperationErrorException with ParamNullReference error subcode.
	CreateStream	Creates a sub-stream with the given name. The returned IStreamContainer is ready for read/write operations. It is recommended to Close the IStreamContainer when done. If it is not explicitly closed, the container is automatically closed when the associated parent container is closed or the associated message (if it is a message-dependent container) is disposed. Whether it is explicitly closed by the client application, or implicitly by the API, any attempt to use this container will result in an OperationErrorException with ParamNullReference error subcode.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
	GetBool	Gets the next field as a Boolean.
	GetByteArray	Gets the next field as a byte array.
	GetChar	Gets the next field as a Char.
	GetDestination	Gets the next field as a IDestination.
	GetDouble	Gets the next field as a double.
	GetFloat	Gets the next field as a float.
	GetInt16	Gets the next field as a Int16.
	GetInt32	Gets the next field as a Int32.
	GetInt64	Gets the next field as a Int64.
	GetInt8	Gets the next field as a Int8 (converted to Int16).
	GetMap	Opens the contained sub-map with the given name. The returned IMapContainer is ready for read and write operations. It is recommended to Close the IMapContainer when done. If it is not explicitly closed, the container is automatically closed when the associated parent container is closed or the associated message (if it is a message-dependent container) is disposed. Whether it is explicitly closed by the client application, or implicitly by the API, any attempt to use this container will result in an OperationErrorException with ParamNullReference error subcode.
	GetNext	Gets the next ISDTField. If the returned ISDTField is of type SDTFieldType.MAP or SDTFieldType.STREAM, it is recommended to Close the container when done. If it is not explicitly closed, the container is automatically closed when the associated parent container is closed or the associated message (if it is a message-dependent container) is disposed.
	GetNull	Gets the next field as a NULL. This is a special accessor; any SDT type with the inclusion of map and stream can be read as null.
	GetSmfMsg	Gets the next field as ISmfMessage.
	GetStream	Opens the contained sub-stream with the given name. The returned IStreamContainer is ready for read and write operations. It is recommended to Close the IStreamContainer when done. If it is not explicitly closed, the container is automatically closed when the associated parent container is closed or the associated message (if it is a message-dependent container) is disposed. Whether it is explicitly closed by the client application, or implicitly by the API, any attempt to use this container will result in an OperationErrorException with ParamNullReference error subcode.
	GetString	Gets the next field as a string.
	GetUInt16	Gets the next field as a UInt16 (converted to Int32).
	GetUInt32	Gets the next field as a UInt32 (converted to Int64).
	GetUInt64	Gets the next field as a UInt64 (converted to Int64, therefore there could a loss of precision).
	GetUInt8	Gets the next field as a UInt8 (byte).
	HasNext	When iterating through a container (map or stream), this method will return false when the end of the container is reached without advancing the read cursor. It will return true otherwise. (Inherited from ISDTContainer.)
	Rewind	Rewinds the container. Normally when HasNext returns false, client applications must call Rewind if they want to reiterate over the container's fields. (Inherited from ISDTContainer.)

Top

Reference

SolaceSystems.Solclient.Messaging.SDT Namespace

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use and copy the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

UNLESS STATED ELSEWHERE BETWEEN YOU AND SOLACE SYSTEMS, INC., THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Send comments on this topic to [email protected]

previous page start next page