The PFCP Translator is used to encode and decode PFCP messages. This is a pure virtual base class that needs to be overridden to support each 3GPP PFCP release. More...

#include <epfcp.h>

Inheritance diagram for PFCP::Translator:

Public Member Functions
	Translator ()
	Default constructor. More...

virtual	~Translator ()
	Class destructor. More...

virtual ReqOutPtr	encodeHeartbeatReq (SndHeartbeatReqData &hb)=0
	Encodes a heartbeat request message. More...

virtual RspOutPtr	encodeHeartbeatRsp (SndHeartbeatRspData &hb)=0
	Encodes a heartbeat response message. More...

virtual RspOutPtr	encodeVersionNotSupportedRsp (ReqInPtr msg)=0
	Encodes a version not supported message. More...

virtual ReqOutPtr	encodeReq (AppMsgReqPtr msg)=0
	Encodes the PFCP request message specified by the application message request. More...

virtual RspOutPtr	encodeRsp (AppMsgRspPtr msg)=0
	Encodes the PFCP response message specified by the application message response. More...

virtual AppMsgReqPtr	decodeReq (ReqInPtr msg)=0
	Decodes the PFCP request message. More...

virtual AppMsgRspPtr	decodeRsp (RspInPtr msg)=0
	Decodes the PFCP response message. More...

virtual RcvdHeartbeatReqDataPtr	decodeHeartbeatReq (ReqInPtr msg)=0
	Decodes the PFCP heartbeat request message. More...

virtual RcvdHeartbeatRspDataPtr	decodeHeartbeatRsp (RspInPtr msg)=0
	Decodes the PFCP heartbeat response message. More...

virtual Void	getMsgInfo (TranslatorMsgInfo &info, cpUChar msg, Int len)=0
	Returns basic information about a message. More...

virtual Bool	isVersionSupported (UChar ver)=0
	Returns True if the specified version is supported by the Translator. More...

virtual MsgClass	messageClass (MsgType mt)=0
	Returns the message class associated with the provided message type. More...

virtual MsgType	pfcpHeartbeatReq ()=0
	Returns the message type value for a heartbeat request message. More...

virtual MsgType	pfcpHeartbeatRsp ()=0
	Returns the message type value for a heartbeat response message. More...

virtual MsgType	pfcpSessionEstablishmentReq ()=0
	Returns the message type value for a session establishment request message. More...

virtual MsgType	pfcpSessionEstablishmentRsp ()=0
	Returns the message type value for a session establishment response message. More...

virtual MsgType	pfcpAssociationSetupReq ()=0
	Returns the message type value for a association setup request message. More...

virtual MsgType	pfcpAssociationSetupRsp ()=0
	Returns the message type value for a association setup response message. More...

Detailed Description

The PFCP Translator is used to encode and decode PFCP messages. This is a pure virtual base class that needs to be overridden to support each 3GPP PFCP release.

Constructor & Destructor Documentation

PFCP::Translator::Translator ( )

Default constructor.

PFCP::Translator::~Translator ( )

virtual

Class destructor.

Reimplemented in PFCP_R15::Translator.

Member Function Documentation

virtual RcvdHeartbeatReqDataPtr PFCP::Translator::decodeHeartbeatReq ( ReqInPtr msg )

pure virtual

Decodes the PFCP heartbeat request message.

Parameters

msg	a pointer to the raw request message.

Returns: a pointer to the decoded heartbeat request message.

virtual RcvdHeartbeatRspDataPtr PFCP::Translator::decodeHeartbeatRsp ( RspInPtr msg )

pure virtual

Decodes the PFCP heartbeat response message.

Parameters

msg	a pointer to the raw response message.

Returns: a pointer to the decoded heartbeat response message.

virtual AppMsgReqPtr PFCP::Translator::decodeReq ( ReqInPtr msg )

pure virtual

Decodes the PFCP request message.

Parameters

msg	a pointer to the application message request.

Returns: a pointer to the decoded application message request.

virtual AppMsgRspPtr PFCP::Translator::decodeRsp ( RspInPtr msg )

pure virtual

Decodes the PFCP response message.

Parameters

msg	a pointer to the application message response.

Returns: a pointer to the decoded application message response.

virtual ReqOutPtr PFCP::Translator::encodeHeartbeatReq ( SndHeartbeatReqData & hb )

pure virtual

Encodes a heartbeat request message.

Parameters

hb	the data associated with this heartbeat request message.

Returns: a pointer to the encoded heartbeat request message.

virtual RspOutPtr PFCP::Translator::encodeHeartbeatRsp ( SndHeartbeatRspData & hb )

pure virtual

Encodes a heartbeat response message.

Parameters

hb	the data associated with this heartbeat response message.

Returns: a pointer to the encoded heartbeat response message.

virtual ReqOutPtr PFCP::Translator::encodeReq ( AppMsgReqPtr msg )

pure virtual

Encodes the PFCP request message specified by the application message request.

Parameters

msg	a pointer to the application request message.

Returns: a pointer to the encoded request.

Implemented in PFCP_R15::Translator.

virtual RspOutPtr PFCP::Translator::encodeRsp ( AppMsgRspPtr msg )

pure virtual

Encodes the PFCP response message specified by the application message response.

Parameters

msg	a pointer to the application response message.

Returns: a pointer to the encoded response.

Implemented in PFCP_R15::Translator.

virtual RspOutPtr PFCP::Translator::encodeVersionNotSupportedRsp ( ReqInPtr msg )

pure virtual

Encodes a version not supported message.

Parameters

msg	a pointer to the request messge that is not supported.

Returns: a pointer to the encoded version not supported message.

virtual Void PFCP::Translator::getMsgInfo	(	TranslatorMsgInfo &	info,
		cpUChar	msg,
		Int	len
	)

pure virtual

Returns basic information about a message.

Parameters

info	a reference to message info object to populate.
msg	a pointer to the raw message buffer.
len	the length of the raw message buffer.

virtual Bool PFCP::Translator::isVersionSupported ( UChar ver )

pure virtual

Returns True if the specified version is supported by the Translator.

Implemented in PFCP_R15::Translator.

virtual MsgClass PFCP::Translator::messageClass ( MsgType mt )

pure virtual

Returns the message class associated with the provided message type.

Returns: the message class associated with the provided message type.

virtual MsgType PFCP::Translator::pfcpAssociationSetupReq ( )

pure virtual

Returns the message type value for a association setup request message.

Returns: the message type value for a association setup request message.

Implemented in PFCP_R15::Translator.

virtual MsgType PFCP::Translator::pfcpAssociationSetupRsp ( )

pure virtual

Returns the message type value for a association setup response message.

Returns: the message type value for a association setup response message.

Implemented in PFCP_R15::Translator.

virtual MsgType PFCP::Translator::pfcpHeartbeatReq ( )

pure virtual

Returns the message type value for a heartbeat request message.

Returns: the message type value for a heartbeat request message.

Implemented in PFCP_R15::Translator.

virtual MsgType PFCP::Translator::pfcpHeartbeatRsp ( )

pure virtual

Returns the message type value for a heartbeat response message.

Returns: the message type value for a heartbeat response message.

Implemented in PFCP_R15::Translator.

virtual MsgType PFCP::Translator::pfcpSessionEstablishmentReq ( )

pure virtual

Returns the message type value for a session establishment request message.

Returns: the message type value for a session establishment request message.

Implemented in PFCP_R15::Translator.

virtual MsgType PFCP::Translator::pfcpSessionEstablishmentRsp ( )

pure virtual

Returns the message type value for a session establishment response message.

Returns: the message type value for a session establishment response message.

Implemented in PFCP_R15::Translator.

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

/home/vagrant/share/code/epctools-omec-pfcp/include/epc/epfcp.h
/home/vagrant/share/code/epctools-omec-pfcp/src/epfcp.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation