INET Framework for OMNeT++/OMNEST
inet::sctp::SctpHeader_Base Class Referenceabstract

Class generated from inet/transportlayer/sctp/SctpHeader.msg:17 by opp_msgtool. More...

#include <SctpHeader_m.h>

Inheritance diagram for inet::sctp::SctpHeader_Base:
inet::TransportHeaderBase inet::FieldsChunk inet::Chunk inet::IPrintableObject inet::IRegionTaggedObject inet::sctp::SctpHeader

Public Member Functions

virtual ~SctpHeader_Base ()
 
virtual SctpHeader_Basedup () const override
 
virtual void parsimPack (omnetpp::cCommBuffer *b) const override
 
virtual void parsimUnpack (omnetpp::cCommBuffer *b) override
 
virtual uint16_t getSrcPort () const
 
virtual void setSrcPort (uint16_t srcPort)
 
virtual uint16_t getDestPort () const
 
virtual void setDestPort (uint16_t destPort)
 
virtual uint32_t getVTag () const
 
virtual void setVTag (uint32_t vTag)
 
virtual bool getChecksumOk () const
 
virtual void setChecksumOk (bool checksumOk)
 
virtual uint32_t getCrc () const
 
virtual void setCrc (uint32_t crc)
 
virtual ::inet::CrcMode getCrcMode () const
 
virtual void setCrcMode (::inet::CrcMode crcMode)
 
virtual unsigned short getHeaderLength () const
 
virtual void setHeaderLength (unsigned short headerLength)
 
virtual void setSctpChunksArraySize (size_t size)=0
 
virtual size_t getSctpChunksArraySize () const =0
 
virtual const SctpChunkgetSctpChunks (size_t k) const =0
 
virtual SctpChunkgetSctpChunksForUpdate (size_t k)
 
virtual void setSctpChunks (size_t k, SctpChunk *sctpChunks)=0
 
virtual void insertSctpChunks (size_t k, SctpChunk *sctpChunks)=0
 
void insertSctpChunks (SctpChunk *sctpChunks)
 
virtual void appendSctpChunks (SctpChunk *sctpChunks)=0
 
virtual void eraseSctpChunks (size_t k)=0
 
- Public Member Functions inherited from inet::TransportHeaderBase
virtual unsigned int getSourcePort () const =0
 
virtual void setSourcePort (unsigned int port)=0
 
virtual unsigned int getDestinationPort () const =0
 
virtual void setDestinationPort (unsigned int port)=0
 
- Public Member Functions inherited from inet::FieldsChunk
 FieldsChunk ()
 
 FieldsChunk (const FieldsChunk &other)
 
virtual ~FieldsChunk ()
 
virtual void parsimPack (cCommBuffer *buffer) const override
 
virtual void parsimUnpack (cCommBuffer *buffer) override
 
virtual void handleChange () override
 
virtual ChunkType getChunkType () const override
 Returns the type of this chunk as an enum member. More...
 
virtual bool containsSameData (const Chunk &other) const override
 Returns true if the two chunks represent the same binary data. More...
 
virtual b getChunkLength () const override
 Returns the length of data represented by this chunk. More...
 
virtual void setChunkLength (b chunkLength)
 
virtual void addChunkLength (b chunkLength)
 
virtual std::ostream & printFieldsToStream (std::ostream &stream, int level, int evFlags=0) const override
 Prints an optinally formatted human readable string representation of the feilds of this chunk to the given stream. More...
 
- Public Member Functions inherited from inet::Chunk
 Chunk ()
 
 Chunk (const Chunk &other)
 
virtual const Ptr< ChunkdupShared () const
 Returns a mutable copy of this chunk in a shared pointer. More...
 
virtual void forEachChild (cVisitor *v) override
 
virtual bool isMutable () const
 
virtual bool isImmutable () const
 
virtual void markImmutable ()
 
void markMutableIfExclusivelyOwned ()
 
virtual bool isComplete () const
 
virtual bool isIncomplete () const
 
virtual void markIncomplete ()
 
virtual bool isCorrect () const
 
virtual bool isIncorrect () const
 
virtual void markIncorrect ()
 
virtual bool isProperlyRepresented () const
 
virtual bool isImproperlyRepresented () const
 
virtual void markImproperlyRepresented ()
 
virtual void moveIterator (Iterator &iterator, b length) const
 
virtual void seekIterator (Iterator &iterator, b position) const
 
virtual bool canInsertAtFront (const Ptr< const Chunk > &chunk) const
 Returns true if this chunk is capable of representing the result. More...
 
virtual bool canInsertAtBack (const Ptr< const Chunk > &chunk) const
 Returns true if this chunk is capable of representing the result. More...
 
virtual bool canInsertAt (const Ptr< const Chunk > &chunk, b offset) const
 Returns true if this chunk is capable of representing the result. More...
 
void insertAtFront (const Ptr< const Chunk > &chunk)
 Inserts the provided chunk at the beginning of this chunk. More...
 
void insertAtBack (const Ptr< const Chunk > &chunk)
 Inserts the provided chunk at the end of this chunk. More...
 
void insertAt (const Ptr< const Chunk > &chunk, b offset)
 Inserts the provided chunk into this chunk. More...
 
virtual bool canRemoveAtFront (b length) const
 Returns true if this chunk is capable of representing the result. More...
 
virtual bool canRemoveAtBack (b length) const
 Returns true if this chunk is capable of representing the result. More...
 
virtual bool canRemoveAt (b offset, b length) const
 Returns true if this chunk is capable of representing the result. More...
 
void removeAtFront (b length)
 Removes the requested part from the beginning of this chunk. More...
 
void removeAtBack (b length)
 Removes the requested part from the end of this chunk. More...
 
void removeAt (b offset, b length)
 Removes the requested part from this chunk. More...
 
int getChunkId () const
 Returns the sequentially assigned id. More...
 
virtual bool isEmpty () const
 Returns true if this chunk contains no data. More...
 
const Ptr< Chunksimplify () const
 Returns the simplified representation of this chunk eliminating all potential redundancies. More...
 
const Ptr< Chunkpeek (const Iterator &iterator, b length=unspecifiedLength, int flags=0) const
 Returns the designated part of the data represented by this chunk in its default representation. More...
 
template<typename T >
bool has (const Iterator &iterator, b length=unspecifiedLength) const
 Returns whether if the designated part of the data is available in the requested representation. More...
 
template<typename T >
const Ptr< Tpeek (const Iterator &iterator, b length=unspecifiedLength, int flags=0) const
 Returns the designated part of the data represented by this chunk in the requested representation. More...
 
virtual SharingRegionTagSetgetRegionTags () override
 Returns all region tags. More...
 
int getNumTags () const
 Returns the number of chunk tags. More...
 
const Ptr< const TagBasegetTag (int index) const
 Returns the chunk tag at the given index. More...
 
void clearTags (b offset=b(0), b length=b(-1))
 Clears the set of chunk tags in the given region. More...
 
void copyTags (const Chunk &source, b sourceOffset=b(0), b offset=b(0), b length=b(-1))
 Copies the set of chunk tags from the source region to the provided region. More...
 
template<typename T >
const Ptr< const TfindTag (b offset=b(0), b length=b(-1)) const
 Returns the chunk tag for the provided type and range, or returns nullptr if no such chunk tag is found. More...
 
template<typename T >
const Ptr< const TgetTag (b offset=b(0), b length=b(-1)) const
 Returns the chunk tag for the provided type and range, or throws an exception if no such chunk tag is found. More...
 
template<typename T >
void mapAllTags (b offset, b length, std::function< void(b, b, const Ptr< const T > &)> f) const
 Maps all tags in the provided range to to the function. More...
 
template<typename T >
void mapAllTagsForUpdate (b offset, b length, std::function< void(b, b, const Ptr< T > &)> f)
 Maps all tags in the provided range to to the function. More...
 
template<typename T >
std::vector< SharingRegionTagSet::RegionTag< const T > > getAllTags (b offset=b(0), b length=b(-1)) const
 Returns all chunk tags for the provided type and range in a detached vector of region tags. More...
 
template<typename T >
std::vector< SharingRegionTagSet::RegionTag< T > > getAllTagsForUpdate (b offset=b(0), b length=b(-1))
 Returns all chunk tags for the provided type and range in a detached vector of region tags. More...
 
template<typename T >
const Ptr< TaddTag (b offset=b(0), b length=b(-1))
 Returns a newly added chunk tag for the provided type and range, or throws an exception if such a chunk tag is already present. More...
 
template<typename T >
const Ptr< TaddTagIfAbsent (b offset=b(0), b length=b(-1))
 Returns a newly added chunk tag for the provided type and range if absent, or returns the chunk tag that is already present. More...
 
template<typename T >
std::vector< SharingRegionTagSet::RegionTag< T > > addTagsWhereAbsent (b offset=b(0), b length=b(-1))
 Returns the newly added chunk tags for the provided type and range where the tag is absent. More...
 
template<typename T >
const Ptr< TremoveTag (b offset, b length)
 Removes the chunk tag for the provided type and range, or throws an exception if no such chunk tag is found. More...
 
template<typename T >
const Ptr< TremoveTagIfPresent (b offset, b length)
 Removes the chunk tag for the provided type and range if present, or returns nullptr if no such chunk tag is found. More...
 
template<typename T >
std::vector< SharingRegionTagSet::RegionTag< T > > removeTagsWherePresent (b offset, b length)
 Removes and returns all chunk tags for the provided type and range. More...
 
virtual std::ostream & printToStream (std::ostream &stream, int level, int evFlags=0) const override
 Prints an optinally formatted human readable string representation of the data present in this chunk to the given stream. More...
 
virtual std::string str () const override
 Returns a human readable string representation of the data present in this chunk. More...
 
- Public Member Functions inherited from inet::IPrintableObject
virtual ~IPrintableObject ()
 
virtual std::string printToString () const
 
virtual std::string printToString (int level, int evFlags=0) const
 
virtual std::string getInfoStringRepresentation (int evFlags=0) const
 
virtual std::string getDetailStringRepresentation (int evFlags=0) const
 
virtual std::string getDebugStringRepresentation (int evFlags=0) const
 
virtual std::string getTraceStringRepresentation (int evFlags=0) const
 
virtual std::string getCompleteStringRepresentation (int evFlags=0) const
 

Protected Member Functions

bool operator== (const SctpHeader_Base &)=delete
 
 SctpHeader_Base ()
 
 SctpHeader_Base (const SctpHeader_Base &other)
 
SctpHeader_Baseoperator= (const SctpHeader_Base &other)
 
- Protected Member Functions inherited from inet::FieldsChunk
const std::vector< uint8_t > * getSerializedBytes () const
 
void setSerializedBytes (const std::vector< uint8_t > *bytes) const
 
virtual const Ptr< ChunkpeekUnchecked (PeekPredicate predicate, PeekConverter converter, const Iterator &iterator, b length, int flags) const override
 
- Protected Member Functions inherited from inet::Chunk
int getBinDumpNumLines () const
 
int getHexDumpNumLines () const
 
const char * getBinDumpLine (int index)
 
const char * getHexDumpLine (int index)
 
const SharingRegionTagSet::RegionTag< TagBase > & _getTag (int index) const
 
void checkMutable () const
 
virtual void doInsertAtFront (const Ptr< const Chunk > &chunk)
 
virtual void doInsertAtBack (const Ptr< const Chunk > &chunk)
 
virtual void doInsertAt (const Ptr< const Chunk > &chunk, b offset)
 
virtual void doRemoveAtFront (b length)
 
virtual void doRemoveAtBack (b length)
 
virtual void doRemoveAt (b offset, b length)
 
template<typename T >
const Ptr< TpeekConverted (const Iterator &iterator, b length, int flags) const
 
template<typename T >
const Ptr< TcheckPeekResult (const Ptr< T > &chunk, int flags) const
 

Protected Attributes

uint16_t srcPort = 0
 
uint16_t destPort = 0
 
uint32_t vTag = 0
 
bool checksumOk = false
 
uint32_t crc = 0
 
::inet::CrcMode crcMode = CRC_MODE_UNDEFINED
 
unsigned short headerLength = 12
 
- Protected Attributes inherited from inet::FieldsChunk
b chunkLength
 
const std::vector< uint8_t > * serializedBytes
 The serialized representation of this chunk or nullptr if not available. More...
 
- Protected Attributes inherited from inet::Chunk
int id
 The id is automatically assigned sequentially during construction. More...
 
int flags
 The boolean chunk flags are merged into a single integer. More...
 
SharingRegionTagSet regionTags
 The set of region tags attached to the data represented by this chunk. More...
 
const typedef Ptr< Chunk >(* PeekConverter )(const Ptr< Chunk > &chunk, const Chunk::Iterator &iterator, b length, int flags)
 

Private Member Functions

void copy (const SctpHeader_Base &other)
 

Additional Inherited Members

- Public Types inherited from inet::Chunk
enum  ChunkType {
  CT_EMPTY, CT_BITCOUNT, CT_BITS, CT_BYTECOUNT,
  CT_BYTES, CT_SLICE, CT_ENCRYPTED, CT_CPACKET,
  CT_SEQUENCE, CT_FIELDS
}
 This enum is used to avoid std::dynamic_cast and dynamicPtrCast. More...
 
enum  PeekFlag {
  PF_ALLOW_NULLPTR = (1 << 0), PF_ALLOW_EMPTY = (1 << 1), PF_ALLOW_INCOMPLETE = (1 << 2), PF_ALLOW_INCORRECT = (1 << 3),
  PF_ALLOW_IMPROPERLY_REPRESENTED = (1 << 4), PF_ALLOW_SERIALIZATION = (1 << 5), PF_ALLOW_ALL = -1
}
 This enum specifies bitmasks for the flags argument of various peek functions. More...
 
- Public Types inherited from inet::IPrintableObject
enum  PrintLevel {
  PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO,
  PRINT_LEVEL_COMPLETE = INT_MIN
}
 
enum  PrintFlag { PRINT_FLAG_FORMATTED = (1 << 0), PRINT_FLAG_MULTILINE = (1 << 1) }
 
- Static Public Member Functions inherited from inet::Chunk
static void serialize (MemoryOutputStream &stream, const Ptr< const Chunk > &chunk, b offset=b(0), b length=b(-1))
 Serializes a chunk into the given stream. More...
 
static const Ptr< Chunkdeserialize (MemoryInputStream &stream, const std::type_info &typeInfo)
 Deserializes a chunk from the given stream. More...
 
- Static Public Attributes inherited from inet::Chunk
static const b unspecifiedLength = b(-std::numeric_limits<int64_t>::max())
 
static bool enableImplicitChunkSerialization = false
 Peeking some part into a chunk that requires automatic serialization will throw an exception when implicit chunk serialization is disabled. More...
 
static int nextId = 0
 
- Protected Types inherited from inet::Chunk
enum  ChunkFlag { CF_IMMUTABLE = (1 << 0), CF_INCOMPLETE = (1 << 1), CF_INCORRECT = (1 << 2), CF_IMPROPERLY_REPRESENTED = (1 << 3) }
 This enum specifies bitmasks for the flags field of Chunk. More...
 
typedef bool(* PeekPredicate) (const Ptr< Chunk > &)
 
- Static Protected Member Functions inherited from inet::FieldsChunk
static const Ptr< ChunkconvertChunk (const std::type_info &typeInfo, const Ptr< Chunk > &chunk, b offset, b length, int flags)
 
- Static Protected Member Functions inherited from inet::Chunk
static const Ptr< ChunkconvertChunk (const std::type_info &typeInfo, const Ptr< Chunk > &chunk, b offset, b length, int flags)
 Creates a new chunk of the given type that represents the designated part of the provided chunk. More...
 

Detailed Description

Class generated from inet/transportlayer/sctp/SctpHeader.msg:17 by opp_msgtool.

class SctpHeader extends TransportHeaderBase
{
    @customize;
    // Source Port
    uint16_t srcPort;
    // Destination Port
    uint16_t destPort;
    // Verification Tag
    uint32_t vTag;
    bool checksumOk;
    uint32_t crc = 0;
    CrcMode crcMode = CRC_MODE_UNDEFINED;
    unsigned short headerLength = 12;
    abstract SctpChunk *sctpChunks[];
}

SctpHeader_Base is only useful if it gets subclassed, and SctpHeader is derived from it. The minimum code to be written for SctpHeader is the following:

class INET_API SctpHeader : public SctpHeader_Base
{
  private:
    void copy(const SctpHeader& other) { ... }
  public:
    SctpHeader() : SctpHeader_Base() {}
    SctpHeader(const SctpHeader& other) : SctpHeader_Base(other) {copy(other);}
    SctpHeader& operator=(const SctpHeader& other) {if (this==&other) return *this; SctpHeader_Base::operator=(other); copy(other); return *this;}
    virtual SctpHeader *dup() const override {return new SctpHeader(*this);}
    // ADD CODE HERE to redefine and implement pure virtual functions from SctpHeader_Base
};

The following should go into a .cc (.cpp) file:

Register_Class(SctpHeader)

Constructor & Destructor Documentation

◆ SctpHeader_Base() [1/2]

inet::sctp::SctpHeader_Base::SctpHeader_Base ( )
protected

◆ SctpHeader_Base() [2/2]

inet::sctp::SctpHeader_Base::SctpHeader_Base ( const SctpHeader_Base other)
protected

◆ ~SctpHeader_Base()

virtual inet::sctp::SctpHeader_Base::~SctpHeader_Base ( )
virtual

Member Function Documentation

◆ appendSctpChunks()

virtual void inet::sctp::SctpHeader_Base::appendSctpChunks ( SctpChunk sctpChunks)
pure virtual

Implemented in inet::sctp::SctpHeader.

◆ copy()

void inet::sctp::SctpHeader_Base::copy ( const SctpHeader_Base other)
private

◆ dup()

virtual SctpHeader_Base* inet::sctp::SctpHeader_Base::dup ( ) const
inlineoverridevirtual

Reimplemented from inet::TransportHeaderBase.

Reimplemented in inet::sctp::SctpHeader.

158 {throw omnetpp::cRuntimeError("You forgot to manually add a dup() function to class SctpHeader");}

◆ eraseSctpChunks()

virtual void inet::sctp::SctpHeader_Base::eraseSctpChunks ( size_t  k)
pure virtual

Implemented in inet::sctp::SctpHeader.

◆ getChecksumOk()

virtual bool inet::sctp::SctpHeader_Base::getChecksumOk ( ) const
virtual

◆ getCrc()

virtual uint32_t inet::sctp::SctpHeader_Base::getCrc ( ) const
virtual

◆ getCrcMode()

virtual ::inet::CrcMode inet::sctp::SctpHeader_Base::getCrcMode ( ) const

◆ getDestPort()

◆ getHeaderLength()

virtual unsigned short inet::sctp::SctpHeader_Base::getHeaderLength ( ) const
virtual

◆ getSctpChunks()

virtual const SctpChunk* inet::sctp::SctpHeader_Base::getSctpChunks ( size_t  k) const
pure virtual

Implemented in inet::sctp::SctpHeader.

◆ getSctpChunksArraySize()

virtual size_t inet::sctp::SctpHeader_Base::getSctpChunksArraySize ( ) const
pure virtual

Implemented in inet::sctp::SctpHeader.

◆ getSctpChunksForUpdate()

virtual SctpChunk* inet::sctp::SctpHeader_Base::getSctpChunksForUpdate ( size_t  k)
inlinevirtual
186 { handleChange();return const_cast<SctpChunk *>(const_cast<SctpHeader_Base*>(this)->getSctpChunks(k));}

◆ getSrcPort()

◆ getVTag()

◆ insertSctpChunks() [1/2]

void inet::sctp::SctpHeader_Base::insertSctpChunks ( SctpChunk sctpChunks)
inline
189 {appendSctpChunks(sctpChunks);}

◆ insertSctpChunks() [2/2]

virtual void inet::sctp::SctpHeader_Base::insertSctpChunks ( size_t  k,
SctpChunk sctpChunks 
)
pure virtual

Implemented in inet::sctp::SctpHeader.

◆ operator=()

SctpHeader_Base& inet::sctp::SctpHeader_Base::operator= ( const SctpHeader_Base other)
protected

◆ operator==()

bool inet::sctp::SctpHeader_Base::operator== ( const SctpHeader_Base )
protecteddelete

◆ parsimPack()

virtual void inet::sctp::SctpHeader_Base::parsimPack ( omnetpp::cCommBuffer *  b) const
overridevirtual

◆ parsimUnpack()

virtual void inet::sctp::SctpHeader_Base::parsimUnpack ( omnetpp::cCommBuffer *  b)
overridevirtual

◆ setChecksumOk()

virtual void inet::sctp::SctpHeader_Base::setChecksumOk ( bool  checksumOk)
virtual

◆ setCrc()

virtual void inet::sctp::SctpHeader_Base::setCrc ( uint32_t  crc)
virtual

◆ setCrcMode()

virtual void inet::sctp::SctpHeader_Base::setCrcMode ( ::inet::CrcMode  crcMode)
virtual

◆ setDestPort()

virtual void inet::sctp::SctpHeader_Base::setDestPort ( uint16_t  destPort)
virtual

◆ setHeaderLength()

virtual void inet::sctp::SctpHeader_Base::setHeaderLength ( unsigned short  headerLength)
virtual

◆ setSctpChunks()

virtual void inet::sctp::SctpHeader_Base::setSctpChunks ( size_t  k,
SctpChunk sctpChunks 
)
pure virtual

Implemented in inet::sctp::SctpHeader.

◆ setSctpChunksArraySize()

virtual void inet::sctp::SctpHeader_Base::setSctpChunksArraySize ( size_t  size)
pure virtual

Implemented in inet::sctp::SctpHeader.

◆ setSrcPort()

virtual void inet::sctp::SctpHeader_Base::setSrcPort ( uint16_t  srcPort)
virtual

◆ setVTag()

virtual void inet::sctp::SctpHeader_Base::setVTag ( uint32_t  vTag)
virtual

Member Data Documentation

◆ checksumOk

bool inet::sctp::SctpHeader_Base::checksumOk = false
protected

◆ crc

uint32_t inet::sctp::SctpHeader_Base::crc = 0
protected

◆ crcMode

::inet::CrcMode inet::sctp::SctpHeader_Base::crcMode = CRC_MODE_UNDEFINED
protected

◆ destPort

uint16_t inet::sctp::SctpHeader_Base::destPort = 0
protected

◆ headerLength

◆ srcPort

uint16_t inet::sctp::SctpHeader_Base::srcPort = 0
protected

◆ vTag

uint32_t inet::sctp::SctpHeader_Base::vTag = 0
protected

The documentation for this class was generated from the following file:
inet::FieldsChunk::handleChange
virtual void handleChange() override
Definition: FieldsChunk.cc:50
inet::sctp::SctpHeader_Base::SctpHeader_Base
SctpHeader_Base()
inet::physicallayer::k
const double k
Definition: Qam1024Modulation.cc:14
inet::sctp::SctpHeader_Base::appendSctpChunks
virtual void appendSctpChunks(SctpChunk *sctpChunks)=0
inet::sctp::SctpHeader_Base::getSctpChunks
virtual const SctpChunk * getSctpChunks(size_t k) const =0