You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
libsxmp/man/sxchannel_open.3

76 lines
1.6 KiB
Groff

9 years ago
.TH SXCHANNEL_OPEN 3 "20 July 2015" "SXMP" "SXMP Library Manual"
.SH NAME
sxchannel_open \- Open RPC channel.
.br
sxchannel_close \- Close RPC channel
.SH SYNOPSIS
9 years ago
.B #include <sxmp/sxmp.h>
.sp
9 years ago
sxchnl_t *sxchannel_open(sxlink_t *co, int type);
int sxchannel_close(sxchnl_t *channel);
.br
.sp
.SH DESCRIPTION
.B sxchannel_open
will open RPC channel using
.B co
9 years ago
hub link with specified type determined by
.B type
that available/permitted to use for current peer.
.br
.B sxchannel_close
will close RPC channel pointed by
.B channel
destroying all allocated structures, including channel itself.
.br
.SH RETURN VALUE
Upon successful completion, the function
.B sxchannel_open
will return a valid pointer to the newly opened RPC channel. Or NULL otherwise setting
.B errno
with error code.
.br
.B sxchannel_close
will return
.B SXE_SUCCESS
on success, otherwise error will be returned.
.SH ERRORS
.B SXE_FAILED
will be returned in case of bad params given.
.br
.B SXE_ENOMEM
will be returned if there are no memory available.
.br
.B SXE_BADPROTO
will be returned if other side has an invalid protocol.
.B SXE_EPERM
will be returned if permission was denied.
.br
.B SXE_LINKERROR
or
.B SXE_LINKBROKEN
will be returned if connection link is broken i.e. SSL read or write was failed due to the broken TCP connection.
.br
.SH BUGS
Not known yet.
.SH EXAMPLE
None.
.SH APPLICATION USAGE
None.
.SH RATIONALE
None.
.SH SEE ALSO
9 years ago
.BI sxhub_set_rpcvalidator(3)
,
.BI sxlink_connect(3)
,
.BI sxlink_close(3)
.SH COPYRIGHT
This is a proprietary software. See COPYING for further details.
.br
(c) Askele Group 2013-2015 <http://askele.com>
.SH AUTHOR
Alexander Vdolainen (vdo@askele.com)