Management API

EIBnetmux server management API. More...

Data Structures
struct	sENMX_StatusEIB
	status information for an active EIBnet/IP connection to eibnetmux More...
struct	sENMX_StatusSocket
	status information for an active eibnetmux socketserver connection More...
struct	sENMX_StatusEIBD
	status information for an active eibd-compatible server connection More...
struct	sENMX_Status
	status information of eibnetmux server More...
Functions
int	enmx_mgmt_connect (ENMX_HANDLE handle)
	connect eibnet/ip client to remote server
int	enmx_mgmt_disconnect (ENMX_HANDLE handle)
	disconnect eibnet/ip client from remote server
int	enmx_mgmt_getloglevel (ENMX_HANDLE handle)
	get current eibnetmux log level
int	enmx_mgmt_setloglevel (ENMX_HANDLE handle, uint16_t level)
	set new eibnetmux log level
int	enmx_mgmt_getaccessblock (ENMX_HANDLE handle)
	get current eibnetmux access block level
int	enmx_mgmt_setaccessblock (ENMX_HANDLE handle, uint16_t level)
	set new eibnetmux access block level
int	enmx_mgmt_close_session (ENMX_HANDLE handle, int session_type, uint32_t session_id)
	forcibly close a client session
void	enmx_mgmt_releasestatus (sENMX_Status *p_status)
	release all memory used by status structure
sENMX_Status *	enmx_mgmt_getstatus (ENMX_HANDLE handle)
	return structure with eibnetmux status

---

Detailed Description

EIBnetmux server management API.

This API supports the following features:

• EIBnet/IP client connection management
• Log level management
• Status

---

Function Documentation

int enmx_mgmt_close_session	(	ENMX_HANDLE	handle,
		int	session_type,
		uint32_t	session_id
	)

forcibly close a client session

Parameters:

	handle	connection handle as returned by enmx_open()
	session_type	1: EIBnet/IP clients, 2: socket clients
	session_id	id of session to close

Returns:

0: ok, -1: error (use geterror to retrieve error code)

int enmx_mgmt_connect

(

ENMX_HANDLE

handle

)

connect eibnet/ip client to remote server

Parameters:

handle

connection handle as returned by enmx_open()

Returns:

0: ok, -1: error (use geterror to retrieve error code)

int enmx_mgmt_disconnect

(

ENMX_HANDLE

handle

)

disconnect eibnet/ip client from remote server

Parameters:

handle

connection handle as returned by enmx_open()

Returns:

0: ok, -1: error (use geterror to retrieve error code)

int enmx_mgmt_getaccessblock

(

ENMX_HANDLE

handle

)

get current eibnetmux access block level

Parameters:

handle

connection handle as returned by enmx_open()

Returns:

>=0: access block level, -1: error (use geterror to retrieve error code)

int enmx_mgmt_getloglevel

(

ENMX_HANDLE

handle

)

get current eibnetmux log level

Parameters:

handle

connection handle as returned by enmx_open()

Returns:

>=0: log level, -1: error (use geterror to retrieve error code)

sENMX_Status* enmx_mgmt_getstatus

(

ENMX_HANDLE

handle

)

return structure with eibnetmux status

Parameters:

handle

connection handle as returned by enmx_open()

Returns:

status pointer to newly allocated structure containing server status information or NULL in case of an error

void enmx_mgmt_releasestatus

(

sENMX_Status *

p_status

)

release all memory used by status structure

Parameters:

p_status

pointer to status structure to release

int enmx_mgmt_setaccessblock	(	ENMX_HANDLE	handle,
		uint16_t	level
	)

set new eibnetmux access block level

Parameters:

	handle	connection handle as returned by enmx_open()
	level	new access block level

Returns:

0: ok, -1: error (use geterror to retrieve error code)

int enmx_mgmt_setloglevel	(	ENMX_HANDLE	handle,
		uint16_t	level
	)

set new eibnetmux log level

Parameters:

	handle	connection handle as returned by enmx_open()
	level	new log level

Returns:

0: ok, -1: error (use geterror to retrieve error code)