eip::ForwardCloseRequest Class Reference

#include <forward_close_request.h>

Inheritance diagram for eip::ForwardCloseRequest:

Public Member Functions
virtual Reader &	deserialize (Reader &reader)
virtual Reader &	deserialize (Reader &reader, size_t length)
virtual size_t	getLength () const
Path &	getPath ()
virtual Writer &	serialize (Writer &writer) const

Public Attributes
EIP_UINT	connection_sn
EIP_UDINT	originator_sn
EIP_UINT	originator_vendor_id
EIP_BYTE	timeout_tick_size
EIP_USINT	timeout_ticks

Private Attributes
Path	path_

Detailed Description

Class to encapsulate a Forward Close request.

Definition at line 49 of file forward_close_request.h.

Member Function Documentation

deserialize() [1/2]

virtual Reader& eip::ForwardCloseRequest::deserialize ( Reader &  reader )

inlinevirtual

Not implemented. Never expect to have to receive this type of message.

Implements eip::serialization::Serializable.

Definition at line 113 of file forward_close_request.h.

deserialize() [2/2]

virtual Reader& eip::ForwardCloseRequest::deserialize ( Reader &  reader, size_t  length  )

inlinevirtual

Not implemented. Never expect to have to receive this type of message.

Implements eip::serialization::Serializable.

Definition at line 105 of file forward_close_request.h.

getLength()

virtual size_t eip::ForwardCloseRequest::getLength ( ) const

inlinevirtual

Get the length of serialized data that would be produced if serialized

Returns

Total length in bytes to be serialized

Implements eip::serialization::Serializable.

Definition at line 72 of file forward_close_request.h.

getPath()

Path& eip::ForwardCloseRequest::getPath ( )

inline

Get the path in the given message router request

Returns

reference to the current Path

Definition at line 63 of file forward_close_request.h.

serialize()

virtual Writer& eip::ForwardCloseRequest::serialize ( Writer &  writer ) const

inlinevirtual

Serialize data into the given buffer

Parameters

writer

Writer to use for serialization

Returns

the writer again

Exceptions

std::length_error

if the buffer is too small for the header data

Implements eip::serialization::Serializable.

Definition at line 89 of file forward_close_request.h.

Member Data Documentation

connection_sn

EIP_UINT eip::ForwardCloseRequest::connection_sn

Definition at line 55 of file forward_close_request.h.

originator_sn

EIP_UDINT eip::ForwardCloseRequest::originator_sn

Definition at line 57 of file forward_close_request.h.

originator_vendor_id

EIP_UINT eip::ForwardCloseRequest::originator_vendor_id

Definition at line 56 of file forward_close_request.h.

path_

Path eip::ForwardCloseRequest::path_

private

Definition at line 119 of file forward_close_request.h.

timeout_tick_size

EIP_BYTE eip::ForwardCloseRequest::timeout_tick_size

Definition at line 53 of file forward_close_request.h.

timeout_ticks

EIP_USINT eip::ForwardCloseRequest::timeout_ticks

Definition at line 54 of file forward_close_request.h.

---

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

• forward_close_request.h