Protocol Class Reference

#include <pep.H>

Public Member Functions
	Protocol (const char *app, const char *name, pepAccess amode)
virtual	~Protocol ()
void	input_table (FILE *stream)
void	input_table (const char *filename)
void	output_table (FILE *stream)
void	output_table (const char *filename)
Logic	news (const char *pname)
void	publish_table ()
void	absorb_table (IntAr *news=NULL)
void	publish (const char *pname)
Logic	absorb (const char *pname)
void	text_input (const char *pname, FILE *stream)
void	text_output (const char *pname, FILE *stream)
void	init (const char *pname)
size_t	size (const char *pname)
void	set_text (const char *pname, const char *textvalue)
void	set_value (const char *pname,...)
void	set_va_lue (const char *pname, va_list val)
void	get_text (const char *pname, char *&textvalue)
void	get_value (const char *pname,...)
void	get_va_lue (const char *pname, va_list val)
ParDesc &	desc (const char *pname)
ParDesc &	desc (int i)
int	n2i (const char *pname)
const char *	i2n (int i)
int	param_count () const
const char *	protocol () const
const char *	application () const

Detailed Description

Protocol provider.

Constructor & Destructor Documentation

Protocol::Protocol	(	const char *	app,
		const char *	name,
		pepAccess	amode
	)

Create/open protocol for application family

virtual Protocol::~Protocol ( )

virtual

Destroy/disconnect protocol

Member Function Documentation

Logic Protocol::absorb

(

const char *

pname

)

Get the value of given parameter from shared memory and return TRUE in case of changed value.

void Protocol::absorb_table

(

IntAr *

news = NULL

)

Check for news and perform absorbtion of shared values into local ones. The whole table method. Can build list of indeces for changed values.

const char* Protocol::application ( ) const

inline

Return symbolic name of the application

ParDesc& Protocol::desc

(

const char *

pname

)

Return reference at param descriptor by its name

ParDesc& Protocol::desc ( int  i )

inline

Return reference at param descriptor by its index

void Protocol::get_text	(	const char *	pname,
		char *&	textvalue
	)

Get value in form described by ParType::get_value() access

const char* Protocol::i2n

(

int

i

)

Quick resolution index to name

void Protocol::init

(

const char *

pname

)

Reinitialize value of parameter

void Protocol::input_table

(

FILE *

stream

)

Text input from stream

void Protocol::input_table

(

const char *

filename

)

Text input from file

int Protocol::n2i

(

const char *

pname

)

Quick resolution name to index

Logic Protocol::news

(

const char *

pname

)

Parameter values' exchange and sychronization

int Protocol::param_count ( ) const

inline

Return count of parameters in protocol

const char* Protocol::protocol ( ) const

inline

Return symbolic names of the protocol

void Protocol::publish

(

const char *

pname

)

Put the value of given parameter to shared memory

void Protocol::publish_table

(

)

Publish only par.values differ from shared ones. The whole table method.

void Protocol::set_text	(	const char *	pname,
		const char *	textvalue
	)

Assign value in form described by ParType::set_value() access

size_t Protocol::size

(

const char *

pname

)

Returns virtual size of value (not real memory block under it!!!)

void Protocol::text_input	(	const char *	pname,
		FILE *	stream
	)

Text input from stream

void Protocol::text_output	(	const char *	pname,
		FILE *	stream
	)

Text output to stream

---

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

• /net/opt/univers/ubp-i-15.3-centos7-x64.urij/include/csi/pep.H