PcapPlusPlus  Next
pcpp::GvcpForceIpAcknowledgeLayer Class Reference

#include <GvcpLayer.h>

Inheritance diagram for pcpp::GvcpForceIpAcknowledgeLayer:
pcpp::GvcpAcknowledgeLayer pcpp::GvcpLayer pcpp::Layer pcpp::IDataContainer

Public Member Functions

 GvcpForceIpAcknowledgeLayer (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
 
 GvcpForceIpAcknowledgeLayer (GvcpResponseStatus status=GvcpResponseStatus::Success, uint16_t ackId=0)
 
- Public Member Functions inherited from pcpp::GvcpAcknowledgeLayer
 GvcpAcknowledgeLayer (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
 
 GvcpAcknowledgeLayer (GvcpResponseStatus status, GvcpCommand command, uint16_t ackId=0)
 
GvcpResponseStatus getStatus () const
 
void setStatus (GvcpResponseStatus status)
 
uint16_t getAckId () const
 
void setAckId (uint16_t ackId)
 
GvcpCommand getCommand () const override
 
uint16_t getDataSize () const override
 
size_t getHeaderLen () const override
 
void computeCalculateFields () override
 Calculate the data size field in the header according to the size of the data that follows the header.
 
std::string toString () const override
 
- Public Member Functions inherited from pcpp::GvcpLayer
void parseNextLayer () override
 Creates a PayloadLayer from the rest of the message, if there is data after this layer.
 
OsiModelLayer getOsiModelLayer () const override
 
- Public Member Functions inherited from pcpp::Layer
 ~Layer () override
 
Layer * getNextLayer () const
 
Layer * getPrevLayer () const
 
ProtocolType getProtocol () const
 
bool isMemberOfProtocolFamily (ProtocolTypeFamily protocolTypeFamily) const
 
uint8_t * getData () const
 
size_t getDataLen () const
 
uint8_t * getLayerPayload () const
 
size_t getLayerPayloadSize () const
 
bool isAllocatedToPacket () const
 
void copyData (uint8_t *toArr) const
 Copy the raw data of this layer to another array. More...
 
size_t copyData (uint8_t *dest, size_t destSize) const
 Copy the raw data of this layer to another array, with a specified maximum size. More...
 
void serialize (ISerializer &serializer) const
 
uint8_t * getDataPtr (size_t offset=0) const override
 

Additional Inherited Members

- Public Types inherited from pcpp::GvcpAcknowledgeLayer
enum class  GvcpResponseStatus : uint16_t {
  Success = 0x0000 , PacketResend = 0x0100 , NotImplemented = 0x8001 , InvalidParameter = 0x8002 ,
  InvalidAddress = 0x8003 , WriteProtect = 0x8004 , BadAlignment = 0x8005 , AccessDenied = 0x8006 ,
  Busy = 0x8007 , LocalProblem = 0x8008 , MsgMismatch = 0x8009 , InvalidProtocol = 0x800A ,
  NoMsg = 0x800B , PacketUnavailable = 0x800C , DataOverrun = 0x800D , InvalidHeader = 0x800E ,
  WrongConfig = 0x800F , PacketNotYetAvailable = 0x8010 , PacketAndPrevRemovedFromMemory = 0x8011 , PacketRemovedFromMemory = 0x8012 ,
  NoRefTime = 0x8013 , PacketTemporarilyUnavailable = 0x8014 , Overflow = 0x8015 , ActionLate = 0x8016 ,
  LeaderTrailerOverflow = 0x8017 , Error = 0x8FFF , Unknown = 0xFFFF
}
 
- Public Types inherited from pcpp::GvcpLayer
enum class  GvcpCommand : uint16_t {
  DiscoveredCmd = 0x0002 , DiscoveredAck = 0x0003 , ForceIpCmd = 0x0004 , ForceIpAck = 0x0005 ,
  PacketResendCmd = 0x0040 , PacketResendAck = 0x0041 , ReadRegCmd = 0x0080 , ReadRegAck = 0x0081 ,
  WriteRegCmd = 0x0082 , WriteRegAck = 0x0083 , ReadMemCmd = 0x0084 , ReadMemAck = 0x0085 ,
  WriteMemCmd = 0x0086 , WriteMemAck = 0x0087 , PendingAck = 0x0089 , EventCmd = 0x00C0 ,
  EventAck = 0x00C1 , EventDataCmd = 0x00C2 , EventDataAck = 0x00C3 , ActionCmd = 0x0100 ,
  ActionAck = 0x0101 , Unknown = 0xFFFF
}
 
- Static Public Member Functions inherited from pcpp::GvcpAcknowledgeLayer
static bool isDataValid (const uint8_t *data, size_t dataLen)
 
- Static Public Member Functions inherited from pcpp::GvcpLayer
static bool isGvcpPort (uint16_t port)
 
static GvcpLayer * parseGvcpLayer (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
 
- Protected Member Functions inherited from pcpp::GvcpAcknowledgeLayer
void serializeLayer (ObjectScope &serializer) const override
 
 GvcpAcknowledgeLayer (GvcpResponseStatus status, GvcpCommand command, uint16_t ackId, size_t bodyLen)
 
- Protected Member Functions inherited from pcpp::GvcpLayer
void initLayer (size_t dataLen)
 
- Protected Member Functions inherited from pcpp::Layer
Packet * getAttachedPacket ()
 Get a pointer to the Packet this layer is attached to (if any). More...
 
Packet const * getAttachedPacket () const
 Get a pointer to the Packet this layer is attached to (if any). More...
 
void allocData (size_t dataLen, bool zeroInit=true)
 Requests the layer to allocate a new data buffer of the specified length. More...
 
template<typename T , typename... Args>
Layer * constructNextLayer (uint8_t *data, size_t dataLen, Args &&... extraArgs)
 Construct the next layer in the protocol stack. No validation is performed on the data. More...
 
template<typename T , typename... Args>
Layer * constructNextLayer (uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
 
template<typename TFactory , typename... Args>
Layer * constructNextLayerFromFactory (TFactory factoryFn, uint8_t *data, size_t dataLen, Args &&... extraArgs)
 Construct the next layer in the protocol stack using a factory functor. More...
 
template<typename TFactory , typename... Args>
Layer * constructNextLayerFromFactory (TFactory factoryFn, uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
 Construct the next layer in the protocol stack using a factory functor. More...
 
template<typename T , typename... Args>
Layer * tryConstructNextLayer (uint8_t *data, size_t dataLen, Args &&... extraArgs)
 
template<typename T , typename... Args>
Layer * tryConstructNextLayer (uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
 
template<typename T , typename TFallback , typename... Args>
Layer * tryConstructNextLayerWithFallback (uint8_t *data, size_t dataLen, Args &&... extraArgs)
 Try to construct the next layer in the protocol stack with a fallback option. More...
 
template<typename T , typename TFallback , typename... Args>
Layer * tryConstructNextLayerWithFallback (uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
 
template<typename TFallback , typename TFactory , typename... Args>
Layer * tryConstructNextLayerFromFactoryWithFallback (TFactory factoryFn, uint8_t *data, size_t dataLen, Args &&... extraArgs)
 Try to construct the next layer in the protocol stack using a factory functor with a fallback option. More...
 
template<typename TFallback , typename TFactory , typename... Args>
Layer * tryConstructNextLayerFromFactoryWithFallback (TFactory factoryFn, uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
 Try to construct the next layer in the protocol stack using a factory functor with a fallback option. More...
 
- Static Protected Member Functions inherited from pcpp::Layer
template<typename T >
static bool canReinterpretAs (const uint8_t *data, size_t dataLen)
 Check if the data is large enough to reinterpret as a type. More...
 

Detailed Description

Represents a GVCP force IP acknowledge (FORCEIP_ACK)

Constructor & Destructor Documentation

◆ GvcpForceIpAcknowledgeLayer() [1/2]

pcpp::GvcpForceIpAcknowledgeLayer::GvcpForceIpAcknowledgeLayer ( uint8_t *  data,
size_t  dataLen,
Layer *  prevLayer,
Packet *  packet 
)
inline

A constructor that creates the layer from an existing packet raw data

Parameters
[in]dataA pointer to the raw data
[in]dataLenSize of the data in bytes
[in]prevLayerA pointer to the previous layer
[in]packetA pointer to the Packet instance where layer will be stored in

◆ GvcpForceIpAcknowledgeLayer() [2/2]

pcpp::GvcpForceIpAcknowledgeLayer::GvcpForceIpAcknowledgeLayer ( GvcpResponseStatus  status = GvcpResponseStatus::Success,
uint16_t  ackId = 0 
)
inlineexplicit

A constructor that creates a new GVCP force IP acknowledge

Parameters
[in]statusThe response status, optional
[in]ackIdThe acknowledge ID, optional