SGCTP::CParameters Class Reference

SGCTP transmission/payload parameters. More...

#include <sgctp/parameters.hpp>

Inheritance diagram for SGCTP::CParameters:

Public Member Functions
	CParameters ()
	~CParameters ()
CPrincipal *	usePrincipal ()
	Return the principal (pointer) More...
void	reset ()
	Reset (undefines) all data. More...
void	setSocketAddress (struct sockaddr *_ptSockaddr, socklen_t *_ptSocklenT)
	Set the network socket address (pointers to existing variables) More...
void	setPrincipalsPath (const char *_pcPrincipalsPath)
	Set the principals (database) path (pointer to existing variable) More...
void	setPasswordSalt (const unsigned char *_pucPasswordSalt)
	Set the cryptographic password salt/nonce (pointer to existing variable) More...

Protected Attributes
struct sockaddr *	ptSockaddr
	Network socket address (pointer to existing variable) More...
socklen_t *	ptSocklenT
	Network socket address length (pointer to existing variable) More...
const char *	pcPrincipalsPath
	Principals (database) path (pointer to existing variable) More...
CPrincipal	oPrincipal
	Principal. More...
const unsigned char *	pucPasswordSalt
	Cryptographic password salt/nonce (pointer to existing variable) More...

Detailed Description

SGCTP transmission/payload parameters.

This class encapsulates the parameters required by SGCTP transmission and payload objects.

Definition at line 40 of file parameters.hpp.

Constructor & Destructor Documentation

SGCTP::CParameters::CParameters ( )

inline

Definition at line 66 of file parameters.hpp.

SGCTP::CParameters::~CParameters ( )

inline

Definition at line 70 of file parameters.hpp.

Member Function Documentation

CPrincipal* SGCTP::CParameters::usePrincipal ( )

inline

Return the principal (pointer)

Definition at line 84 of file parameters.hpp.

void SGCTP::CParameters::reset ( )

inline

Reset (undefines) all data.

Definition at line 94 of file parameters.hpp.

void SGCTP::CParameters::setSocketAddress ( struct sockaddr *  _ptSockaddr, socklen_t *  _ptSocklenT  )

inline

Set the network socket address (pointers to existing variables)

Parameters

[in]	_ptSockaddr	Socket address object (pointer to existing variable)
[in]	_ptSocklenT	Socket address object length (pointer to existing variable)

Definition at line 108 of file parameters.hpp.

void SGCTP::CParameters::setPrincipalsPath ( const char *  _pcPrincipalsPath )

inline

Set the principals (database) path (pointer to existing variable)

Parameters

[in]

_pcPrincipalsPath

Principals (database) path (pointer to existing variable)

Definition at line 120 of file parameters.hpp.

void SGCTP::CParameters::setPasswordSalt ( const unsigned char *  _pucPasswordSalt )

inline

Set the cryptographic password salt/nonce (pointer to existing variable)

Parameters

[in]

_pucPasswordSalt

Cryptographic password salt/nonce (pointer to existing variable)

Definition at line 129 of file parameters.hpp.

Member Data Documentation

struct sockaddr* SGCTP::CParameters::ptSockaddr

protected

Network socket address (pointer to existing variable)

Definition at line 49 of file parameters.hpp.

socklen_t* SGCTP::CParameters::ptSocklenT

protected

Network socket address length (pointer to existing variable)

Definition at line 51 of file parameters.hpp.

const char* SGCTP::CParameters::pcPrincipalsPath

protected

Principals (database) path (pointer to existing variable)

Definition at line 54 of file parameters.hpp.

CPrincipal SGCTP::CParameters::oPrincipal

protected

Principal.

Definition at line 56 of file parameters.hpp.

const unsigned char* SGCTP::CParameters::pucPasswordSalt

protected

Cryptographic password salt/nonce (pointer to existing variable)

Definition at line 59 of file parameters.hpp.

---

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

• sgctp/parameters.hpp