Struct opcua_client::prelude::TcpCodec

pub struct TcpCodec { /* private fields */ }

Implements a tokio codec that as close as possible, allows incoming data to be transformed into OPC UA message chunks with no intermediate buffers. Chunks are subsequently transformed into messages so there is still some buffers within message chunks, but not at the raw socket level.

Implementations

impl TcpCodec

pub fn new(
    abort: Arc<RwLock<bool>>,
    decoding_options: DecodingOptions
) -> TcpCodec

Constructs a new TcpCodec. The abort flag is set to terminate the codec even while it is waiting for a frame to arrive.

Trait Implementations

impl Decoder for TcpCodec

type Item = Message

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

fn decode(
    &mut self,
    buf: &mut BytesMut
) -> Result<Option<<TcpCodec as Decoder>::Item>, <TcpCodec as Decoder>::Error>

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof(
    &mut self,
    buf: &mut BytesMut
) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self> where
    T: AsyncRead + AsyncWrite, 

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl Encoder<Message> for TcpCodec

type Error = Error

The type of encoding errors.

fn encode(&mut self, data: Message, buf: &mut BytesMut) -> Result<(), Error>

Encodes a frame into the buffer provided.