PcapPlusPlus  Next
pcpp::ObjectScope Class Reference

#include <Serializers.h>

Inheritance diagram for pcpp::ObjectScope:
pcpp::ScopeBase pcpp::ISerializer

Public Member Functions

 ObjectScope (ISerializer *serializer, const FieldDescriptor &field)
 
 ~ObjectScope () override
 Close the object.
 
void writeField (const FieldDescriptor &field, const std::string &value) override
 
void writeField (const FieldDescriptor &field, int64_t value) override
 
void writeField (const FieldDescriptor &field, uint64_t value) override
 
void writeField (const FieldDescriptor &field, double value) override
 
void writeField (const FieldDescriptor &field, bool value) override
 
- Public Member Functions inherited from pcpp::ScopeBase
void writeField (const FieldDescriptor &field, const std::string &value) override
 
void writeField (const FieldDescriptor &field, int64_t value) override
 
void writeField (const FieldDescriptor &field, uint64_t value) override
 
void writeField (const FieldDescriptor &field, double value) override
 
void writeField (const FieldDescriptor &field, bool value) override
 
void writeNullField (const FieldDescriptor &field) override
 
void writeHexField (const FieldDescriptor &field, uint64_t value) override
 
- Public Member Functions inherited from pcpp::ISerializer
virtual ~ISerializer ()=default
 Destroy the serializer.
 
ArrayScope writeArray (const FieldDescriptor &field)
 
ObjectScope writeObject (const FieldDescriptor &field)
 

Detailed Description

RAII scope for a serialized object.

Constructor & Destructor Documentation

◆ ObjectScope()

pcpp::ObjectScope::ObjectScope ( ISerializer *  serializer,
const FieldDescriptor &  field 
)

Create an object scope.

Parameters
[in]serializerThe serializer owning the object
[in]fieldThe descriptor of the object field

Member Function Documentation

◆ writeField() [1/5]

void pcpp::ScopeBase::writeField
override

Write a boolean field.

Parameters
[in]fieldThe descriptor of the field
[in]valueThe boolean value to write

◆ writeField() [2/5]

void pcpp::ScopeBase::writeField
override

Write a string field.

Parameters
[in]fieldThe descriptor of the field
[in]valueThe string value to write

◆ writeField() [3/5]

void pcpp::ScopeBase::writeField
override

Write a floating-point field.

Parameters
[in]fieldThe descriptor of the field
[in]valueThe floating-point value to write

◆ writeField() [4/5]

void pcpp::ScopeBase::writeField
override

Write a signed int64 field.

Parameters
[in]fieldThe descriptor of the field
[in]valueThe signed integer value to write

◆ writeField() [5/5]

void pcpp::ScopeBase::writeField
override

Write an unsigned int64 field.

Parameters
[in]fieldThe descriptor of the field
[in]valueThe unsigned integer value to write