Public Member Functions | Public Attributes | Private Attributes | List of all members
eip::ForwardCloseSuccess Class Reference

#include <forward_close_success.h>

Inheritance diagram for eip::ForwardCloseSuccess:
Inheritance graph
[legend]

Public Member Functions

virtual Reader & deserialize (Reader &reader, size_t length)
 
virtual Reader & deserialize (Reader &reader)
 
virtual size_t getLength () const
 
shared_ptr< Serializable > getResponseData () const
 
virtual Writer & serialize (Writer &writer) const
 

Public Attributes

EIP_UINT connection_sn
 
EIP_UDINT originator_sn
 
EIP_UINT originator_vendor_id
 

Private Attributes

shared_ptr< Serializable > response_data_
 

Detailed Description

Class to encapsulate the response to a Forward Close request when successful Note that the response is different if the request fails.

Definition at line 53 of file forward_close_success.h.

Member Function Documentation

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

Don't need extra length info, as the message data defines its length

Definition at line 101 of file forward_close_success.h.

virtual Reader& eip::ForwardCloseSuccess::deserialize ( Reader &  reader)
inlinevirtual

Deserialize the forward open response data. Length is implicit.

Definition at line 109 of file forward_close_success.h.

virtual size_t eip::ForwardCloseSuccess::getLength ( ) const
inlinevirtual

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

Returns
Total length in bytes to be serialized

Definition at line 74 of file forward_close_success.h.

shared_ptr<Serializable> eip::ForwardCloseSuccess::getResponseData ( ) const
inline

Get the response data object in this message

Returns
Serializable data to be used for this response

Definition at line 65 of file forward_close_success.h.

virtual Writer& eip::ForwardCloseSuccess::serialize ( Writer &  writer) const
inlinevirtual

Serialize data into the given buffer

Parameters
writerWriter to use for serialization
Returns
the writer again
Exceptions
std::length_errorif the buffer is too small for the header data

Definition at line 93 of file forward_close_success.h.

Member Data Documentation

EIP_UINT eip::ForwardCloseSuccess::connection_sn

Definition at line 57 of file forward_close_success.h.

EIP_UDINT eip::ForwardCloseSuccess::originator_sn

Definition at line 59 of file forward_close_success.h.

EIP_UINT eip::ForwardCloseSuccess::originator_vendor_id

Definition at line 58 of file forward_close_success.h.

shared_ptr<Serializable> eip::ForwardCloseSuccess::response_data_
private

Definition at line 131 of file forward_close_success.h.


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


odva_ethernetip
Author(s): Kareem Shehata
autogenerated on Mon Jun 10 2019 14:00:16