Proton DotNet
Public Member Functions | Properties | List of all members
Apache.Qpid.Proton.Codec.IEncoderState Interface Reference

Defines a state object that is used with the AMQP Encoder type to hold intermediate state and provide additional functionality that can be used during the encode process. More...

Inheritance diagram for Apache.Qpid.Proton.Codec.IEncoderState:
Apache.Qpid.Proton.Codec.Encoders.ProtonEncoderState

Public Member Functions

void Reset ()
 Resets the encoder after a complete encode operation freeing any held resources and preparing for a new encode operation. More...
 
IProtonBuffer EncodeUtf8 (IProtonBuffer buffer, string value)
 Encodes the given string into UTF-8 bytes that are written into the provided buffer. More...
 

Properties

IEncoder Encoder [get]
 Gets the IEncoder instance that was used when creating this encoder state object. More...
 

Detailed Description

Defines a state object that is used with the AMQP Encoder type to hold intermediate state and provide additional functionality that can be used during the encode process.

Member Function Documentation

◆ EncodeUtf8()

IProtonBuffer Apache.Qpid.Proton.Codec.IEncoderState.EncodeUtf8 ( IProtonBuffer  buffer,
string  value 
)

Encodes the given string into UTF-8 bytes that are written into the provided buffer.

Parameters
buffer
valuethe string that is to be encoded as a UTF-8 byte sequence
Returns
A reference to the passed buffer where the encoding was done.

Implemented in Apache.Qpid.Proton.Codec.Encoders.ProtonEncoderState.

◆ Reset()

void Apache.Qpid.Proton.Codec.IEncoderState.Reset ( )

Resets the encoder after a complete encode operation freeing any held resources and preparing for a new encode operation.

Implemented in Apache.Qpid.Proton.Codec.Encoders.ProtonEncoderState.

Property Documentation

◆ Encoder

IEncoder Apache.Qpid.Proton.Codec.IEncoderState.Encoder
get

Gets the IEncoder instance that was used when creating this encoder state object.


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