10.24.0

ISDTContainer Interface

The parent interface of any Structured Data Type (SDT) container. Subinterfaces of ISDTContainer include IMapContainer and IStreamContainer.

Note: Calling Dispose() on a message-dependent container has no effect on it. The lifecycle of the container in this case is tied to that of the containing message.

Definition

Namespace: SolaceSystems.Solclient.Messaging.SDT
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 10.24.0
C#
public interface ISDTContainer : IDisposable
Implements
IDisposable

Methods

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).

    • DisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
    (Inherited from IDisposable)
    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.
    Rewind Rewinds the container. Normally when HasNext returns false, client applications must call Rewind if they want to reiterate over the container's fields.

    See Also