sENMX_Status Struct Reference
[Management API]

status information of eibnetmux server More...

#include <enmx_lib.h>

Collaboration diagram for sENMX_Status:

[legend]

Data Fields
int	status_version
	version of status information supported by eibnetmux server, indicates which fields are filled in
struct {
int   status_version
	version of common block status information, indicates valid fields
char *   version
	server version string
int   loglevel
	server's log level
uint32_t   uptime
	current uptime of server, in seconds
uint16_t   uid
	unix user id server is running under
uint16_t   gid
	unix group id server is running under
int   daemon
	true if server is running in daemon mode
}	common
	generic server status
struct {
int   status_version
	version of client block status information, indicates valid fields
int   connected
	true if connected to upstream EIBnet/IP server such as N148/21
uint32_t   uptime
	time in seconds since client is connected
uint32_t   session_received
	number of requests received since client is connected
uint32_t   session_sent
	number of requests sent since client is connected
uint32_t   total_received
	number of requests received since first client connection was established
uint32_t   total_sent
	number of requests sent since first client connection was established
uint16_t   queue_len
	number of requests in queue, waiting to be sent
uint16_t   missed_heartbeat
	number of EIBnet/IP heartbeats missed
char *   target_name
	name of upstream EIBnet/IP server
uint32_t   target_ip
	IP address of upstream EIBnet/IP server.
uint16_t   target_port
	UDP port used for control connection by upstream EIBnet/IP server (should generally be 3601).
uint32_t   source_ip
	eibnetmux' IP address used to communicate with upstream server
uint8_t   loopback
	set to 2 if EIBnetmux operates in loopback mode and has no connection to a KNX bus
}	client
	eibnetmux client status
struct {
int   status_version
	version of EIBnet/IP server block status information, indicates valid fields
int   active
	true if EIBnet/IP server is active
uint16_t   port
	UDP port used to receive requests.
int   max_connections
	maxmimum number of EIBnet/IP clients
int   nr_clients
	number of currently connected clients
uint32_t   received
	number of requests received
uint32_t   sent
	number of requests sent
uint16_t   queue_len
	number of requests in queue, waiting to be sent
uint16_t   default_level
	default authorisation level
uint16_t   access_block
	block all access above this authorisation level
sENMX_StatusEIB *   clients
	pointer to linked list of clients
}	server
	eibnetmux EIBnet/IP server status
struct {
int   status_version
	version of socketserver block status information, indicates valid fields
int   active_tcp
	true if TCP socketserver is active
int   active_unix
	true if named pipe socketserver is active
uint16_t   port
	TCP used to receive requests.
char *   path
	name of named pipe
int   max_connections
	maximum number of socketserver clients
int   nr_clients
	number of currently connected clients
uint32_t   received
	number of requests received
uint32_t   sent
	number of requests sent
uint16_t   queue_len
	number of requests in queue, waiting to be sent
int   authentication
	true if eibnetmux supports authentication
sENMX_StatusSocket *   clients
	pointer to linked list of clients
}	socketserver
	eibnetmux socketserver status
struct {
int   status_version
	version of eibd-compatible server block status information, indicates valid fields
int   active
	true if EIBD server is active
uint16_t   port
	TCP used to receive requests.
int   max_connections
	maximum number of eibd clients
int   nr_clients
	number of currently connected clients
uint32_t   received
	number of requests received
uint32_t   sent
	number of requests sent
uint16_t   queue_len
	number of requests in queue, waiting to be sent
sENMX_StatusEIBD *   clients
	pointer to linked list of clients
}	eibd
	eibnetmux eibd-server status

---

Detailed Description

status information of eibnetmux server

Examples:

eibstatus.c.

---

Field Documentation

uint16_t sENMX_Status::access_block

block all access above this authorisation level

Examples:

eibstatus.c.

int sENMX_Status::active

true if EIBnet/IP server is active

true if EIBD server is active

Examples:

eibstatus.c.

int sENMX_Status::active_tcp

true if TCP socketserver is active

Examples:

eibstatus.c.

int sENMX_Status::active_unix

true if named pipe socketserver is active

Examples:

eibstatus.c.

int sENMX_Status::authentication

true if eibnetmux supports authentication

Examples:

eibstatus.c.

struct { ... } sENMX_Status::client

eibnetmux client status

Examples:

eibstatus.c.

sENMX_StatusEIBD* sENMX_Status::clients

pointer to linked list of clients

sENMX_StatusSocket* sENMX_Status::clients

pointer to linked list of clients

sENMX_StatusEIB* sENMX_Status::clients

pointer to linked list of clients

Examples:

eibstatus.c.

struct { ... } sENMX_Status::common

generic server status

Examples:

eibstatus.c.

int sENMX_Status::connected

true if connected to upstream EIBnet/IP server such as N148/21

Examples:

eibstatus.c.

int sENMX_Status::daemon

true if server is running in daemon mode

Examples:

eibstatus.c.

uint16_t sENMX_Status::default_level

default authorisation level

Examples:

eibstatus.c.

struct { ... } sENMX_Status::eibd

eibnetmux eibd-server status

Examples:

eibstatus.c.

uint16_t sENMX_Status::gid

unix group id server is running under

Examples:

eibstatus.c.

int sENMX_Status::loglevel

server's log level

Examples:

eibstatus.c.

uint8_t sENMX_Status::loopback

set to 2 if EIBnetmux operates in loopback mode and has no connection to a KNX bus

Examples:

eibstatus.c.

int sENMX_Status::max_connections

maxmimum number of EIBnet/IP clients

maximum number of eibd clients

maximum number of socketserver clients

Examples:

eibstatus.c.

uint16_t sENMX_Status::missed_heartbeat

number of EIBnet/IP heartbeats missed

Examples:

eibstatus.c.

int sENMX_Status::nr_clients

number of currently connected clients

Examples:

eibstatus.c.

char* sENMX_Status::path

name of named pipe

Examples:

eibstatus.c.

uint16_t sENMX_Status::port

UDP port used to receive requests.

TCP used to receive requests.

Examples:

eibstatus.c.

uint16_t sENMX_Status::queue_len

number of requests in queue, waiting to be sent

Examples:

eibstatus.c.

uint32_t sENMX_Status::received

number of requests received

Examples:

eibstatus.c.

uint32_t sENMX_Status::sent

number of requests sent

Examples:

eibstatus.c.

struct { ... } sENMX_Status::server

eibnetmux EIBnet/IP server status

Examples:

eibstatus.c.

uint32_t sENMX_Status::session_received

number of requests received since client is connected

Examples:

eibstatus.c.

uint32_t sENMX_Status::session_sent

number of requests sent since client is connected

Examples:

eibstatus.c.

struct { ... } sENMX_Status::socketserver

eibnetmux socketserver status

Examples:

eibstatus.c.

uint32_t sENMX_Status::source_ip

eibnetmux' IP address used to communicate with upstream server

Examples:

eibstatus.c.

int sENMX_Status::status_version

version of status information supported by eibnetmux server, indicates which fields are filled in

version of eibd-compatible server block status information, indicates valid fields

version of socketserver block status information, indicates valid fields

version of EIBnet/IP server block status information, indicates valid fields

version of client block status information, indicates valid fields

version of common block status information, indicates valid fields

Examples:

eibstatus.c.

uint32_t sENMX_Status::target_ip

IP address of upstream EIBnet/IP server.

Examples:

eibstatus.c.

char* sENMX_Status::target_name

name of upstream EIBnet/IP server

Examples:

eibstatus.c.

uint16_t sENMX_Status::target_port

UDP port used for control connection by upstream EIBnet/IP server (should generally be 3601).

Examples:

eibstatus.c.

uint32_t sENMX_Status::total_received

number of requests received since first client connection was established

Examples:

eibstatus.c.

uint32_t sENMX_Status::total_sent

number of requests sent since first client connection was established

Examples:

eibstatus.c.

uint16_t sENMX_Status::uid

unix user id server is running under

Examples:

eibstatus.c.

uint32_t sENMX_Status::uptime

current uptime of server, in seconds

time in seconds since client is connected

Examples:

eibstatus.c.

char* sENMX_Status::version

server version string

Examples:

eibstatus.c.