C_ProtocolFrame Class Reference

#include <C_ProtocolFrame.hpp>

Inheritance diagram for C_ProtocolFrame:


Public Types
typedef enum C_ProtocolFrame::_protocol_type	T_ProtocolType
typedef enum C_ProtocolFrame::_protocol_type *	T_pProtocolType
typedef enum C_ProtocolFrame::_msg_error_code	T_MsgError
typedef enum C_ProtocolFrame::_msg_error_code *	T_pMsgError
enum	_protocol_type { E_PROTOCOL_BINARY, E_PROTOCOL_EXTERNAL, E_PROTOCOL_TEXT, E_PROTOCOL_UNKNOWN }
enum	_msg_error_code { E_MSG_OK = 0, E_MSG_ERROR_DECODING, E_MSG_ERROR_DECODING_SIZE_LESS, E_MSG_ERROR_ENCODING, E_MSG_EXTERNAL_ERROR, E_MSG_INTERNAL_ERROR }
Public Member Functions
	C_ProtocolFrame ()
virtual	~C_ProtocolFrame ()
T_ProtocolType	get_type ()
virtual C_MessageFrame *	create_new_message (C_MessageFrame *P_msg)=0
virtual C_MessageFrame *	create_new_message (void P_xml, T_pInstanceDataList P_list, int P_nb_body_value)=0
virtual char *	message_name ()=0
virtual char *	message_component_name ()=0
virtual T_pNameAndIdList	message_name_list ()=0
virtual T_pNameAndIdList	message_component_name_list ()=0
virtual bool	find_present_session (int P_msg_id, int P_id)=0
virtual int	find_field (char *P_name)=0
virtual T_TypeType	get_field_type (int P_id, int P_sub_id)=0
virtual bool	check_sub_entity_needed (int P_id)=0
C_ProtocolStatsFrame *	get_stats ()
void	set_stats (C_ProtocolStatsFrame *P_stats)
virtual T_ExternalMethod	find_method_extern (char *P_name)
char *	name ()
Protected Attributes
C_ProtocolStatsFrame *	m_stats
T_ProtocolType	m_type
char *	m_name

Detailed Description

Protocol frame class.

Definition at line 49 of file C_ProtocolFrame.hpp.

enum C_ProtocolFrame::_msg_error_code

Error message code
Enumerator:

E_MSG_ERROR_DECODING_SIZE_LESS Not able to decode the message

E_MSG_ERROR_ENCODING Need more data to decode the message. This is the case when a message is not received in one recv

E_MSG_EXTERNAL_ERROR Not able to encode the message

E_MSG_INTERNAL_ERROR used for EXTERNAL protocol type

Definition at line 63 of file C_ProtocolFrame.hpp.
00063 { 00064 E_MSG_OK = 0, 00065 E_MSG_ERROR_DECODING, 00066 E_MSG_ERROR_DECODING_SIZE_LESS, 00067 E_MSG_ERROR_ENCODING, 00068 E_MSG_EXTERNAL_ERROR, 00069 E_MSG_INTERNAL_ERROR 00070 } T_MsgError, *T_pMsgError ;

enum C_ProtocolFrame::_protocol_type

Possible protocol types
Enumerator:

E_PROTOCOL_EXTERNAL Used by Diameter, Radius and the like

E_PROTOCOL_TEXT Used by OpenCall TCAP. Can be used for any external API

E_PROTOCOL_UNKNOWN Unused

Definition at line 55 of file C_ProtocolFrame.hpp.
00055 { 00056 E_PROTOCOL_BINARY, 00057 E_PROTOCOL_EXTERNAL, 00058 E_PROTOCOL_TEXT, 00059 E_PROTOCOL_UNKNOWN 00060 } T_ProtocolType, *T_pProtocolType ;

virtual C_MessageFrame* C_ProtocolFrame::create_new_message ( void * P_xml,

T_pInstanceDataList P_list,

int * P_nb_body_value

) [pure virtual]

Create a new message
Implemented in C_ProtocolBinary, C_ProtocolBinaryBodyNotInterpreted, C_ProtocolBinarySeparator, C_ProtocolExternal, C_ProtocolText, and C_ProtocolTlv.

T_ProtocolType C_ProtocolFrame::get_type ( ) [inline]

Return the type of the protocol
Definition at line 77 of file C_ProtocolFrame.hpp.
References m_type.
Referenced by C_TransSCTP::open(), and C_TransIP::open().
00077 { return (m_type); }

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

Generated on Wed Mar 7 14:57:55 2007 for Seagull by

1.4.6