libmbus.3

OpenMODBUS/TCP to RS-232/485 MODBUS RTU gateway librar Zhejiang Univ. Hangzhou, China Dec.2006

.TH "libmbus" 3 "13 September 2003" "libmbus ver 0.1.1" "MBUS Library Interface"
.SH "NAME"
mbus_version, mbus_init, mbus_connect, mbus_reconnect, mbus_close, mbus_excode,
mbus_connected \- General purpose MBUS library functions
.SH "SYNOPSIS"
.ft B
#include <mbus.h>
.br
.sp
char *mbus_version(mbus_struct *mbus);
.sp
mbus_struct *mbus_init(mbus_struct *mbus);
.sp
int mbus_connect
.br
(
.br
	mbus_struct *mbus,
.br
	const char *host_addr,
.br
	mbus_uword host_port,
.br
	mbus_uword flags
.br
);
.sp
int mbus_reconnect(mbus_struct *mbus);
.sp
int mbus_close(mbus_struct *mbus);
.sp
mbus_ubyte mbus_excode(mbus_struct *mbus);
.sp
int mbus_connected(mbus_struct *mbus);
.ft R
.SH "PARAMETERS"
.TP
.BR "mbus_struct *mbus" "	(mbus_version)"
Pointer to MODBUS structure.
.TP
.BR "mbus_struct *mbus" "	(mbus_init)"
Pointer to structure to be initialized
(if NULL - the memory will be allocated
for the structure before initializing).
.TP
.BR "mbus_struct *mbus" "	(mbus_connect)"
Pointer to MBUS structure.
.TP
.B "const char *host_addr"
Mbusd server host address (DNS or canonical form).
.TP
.B "mbus_uword host_port"
Mbusd IP port (1-65535).
.TP
.B "mbus_uword flags"
Additional flags (isn't used in this version).
.SH "DESCRIPTION"
.SS "mbus_version"
Get library version info.
.SS "mbus_init"
Initialization of MBUS structure.
.SS "mbus_connect"
Connect to mbusd server.
.SS "mbus_reconnect"
Reconnect to mbusd server.
.SS "mbus_close"
Disconnect from mbusd server.
.SS "mbus_excode"
Get last request exception code.
.SS "mbus_connected"
Get connection status code.
.SH "RETURNS"
.SS "mbus_version"
Pointer to library version internal string.
.SS "mbus_init"
Pointer to structure (NULL in case of error).
.SS "mbus_connect"
0 if successfully connected;
-1 in case of error.
.SS "mbus_reconnect"
0 if successfully reconnected;
-1 in case of error.
.SS "mbus_close"
0 if connection successfully closed;
-1 in case of error.
.SS "mbus_excode"
Exception code (0-255).
.SS "mbus_connected"
-1 if structure is not initialized;
0 if connection is not established;
1 if successfully connected.
.SH "NOTE"
.SS "mbus_init"
This function must be called before any call to
the library just once for each MBUS stucture.
.SH "SEE ALSO"
libmbus_cmd(3)
.SH "AUTHORS"
Victor Antonovich ([e-mail])