Init Class Reference

#include <init.h>

Public Member Functions
void	close ()
int	process (const Options &opt)
const ConfigFile &	cfg () const
const SaFile &	sa () const
Message &	msg ()
SockBase *	sk ()
char	getNetSelect ()
bool	use_uds () const
uint8_t	allow_unauth () const

Detailed Description

Initilize configuration file, socket, message based on PMC options. The user can write an application using the pmc command line.

Member Function Documentation

allow_unauth()

uint8_t Init::allow_unauth ( ) const

inline

Allow unauthnticated parameter

Returns

Allow unauthnticated value

cfg()

const ConfigFile& Init::cfg ( ) const

inline

Get configuration file object

Returns

object

close()

void Init::close

(

)

Close socket

getNetSelect()

char Init::getNetSelect ( )

inline

Get network selection character

Returns

'u' for unix socket using a SockUnix object, '4' for a PTP IPv4 socket using a SockIp4 object, '6' for a PTP IPv6 socket using a SockIp6 object, '2' for a PTP layer 2 socket using a SockRaw object,

msg()

Message& Init::msg ( )

inline

Get Message object

Returns

object

process()

int Init::process

(

const Options &

opt

)

Process PMC options

Parameters

[in]

opt

PMC options

Returns

0 on scuccess

Note

function return proper value to return from main()

sa()

const SaFile& Init::sa ( ) const

inline

Get authentication security association file object

Returns

object

sk()

SockBase* Init::sk ( )

inline

Get Socket object

Returns

object or null if not exist

Note

User should not try to free this socket object

use_uds()

bool Init::use_uds ( ) const

inline

Is the socket provide by this object, a Unix socket?

Returns

true if the socket is a UDS socket

---

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

• pub/init.h