2015-10-27 00:20:44 +02:00
|
|
|
.TH SXCHANNEL_OPEN 3 "20 July 2015" "SXMP" "SXMP Library Manual"
|
2015-08-05 01:23:16 +03:00
|
|
|
.SH NAME
|
|
|
|
|
sxchannel_open \- Open RPC channel.
|
|
|
|
|
.br
|
|
|
|
|
sxchannel_close \- Close RPC channel
|
|
|
|
|
.SH SYNOPSIS
|
2015-10-27 00:20:44 +02:00
|
|
|
.B #include <sxmp/sxmp.h>
|
2015-08-05 01:23:16 +03:00
|
|
|
.sp
|
2015-11-11 16:01:18 +02:00
|
|
|
sxchnl_t *sxchannel_open(sxlink_t *co, int type);
|
2015-08-05 01:23:16 +03:00
|
|
|
|
2015-11-10 23:17:39 +02:00
|
|
|
int sxchannel_close(sxchnl_t *channel);
|
2015-08-05 01:23:16 +03:00
|
|
|
|
|
|
|
|
.br
|
|
|
|
|
.sp
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.B sxchannel_open
|
|
|
|
|
will open RPC channel using
|
|
|
|
|
.B co
|
2015-11-13 15:04:19 +02:00
|
|
|
hub link with specified type determined by
|
2015-08-05 01:23:16 +03:00
|
|
|
.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
|
2015-11-10 23:17:39 +02:00
|
|
|
.B SXE_SUCCESS
|
2015-08-05 01:23:16 +03:00
|
|
|
on success, otherwise error will be returned.
|
|
|
|
|
.SH ERRORS
|
2015-11-10 23:17:39 +02:00
|
|
|
.B SXE_FAILED
|
2015-08-05 01:23:16 +03:00
|
|
|
will be returned in case of bad params given.
|
|
|
|
|
.br
|
2015-11-10 23:17:39 +02:00
|
|
|
.B SXE_ENOMEM
|
2015-08-05 01:23:16 +03:00
|
|
|
will be returned if there are no memory available.
|
|
|
|
|
.br
|
2015-11-10 23:17:39 +02:00
|
|
|
.B SXE_BADPROTO
|
2015-08-05 01:23:16 +03:00
|
|
|
will be returned if other side has an invalid protocol.
|
2015-11-10 23:17:39 +02:00
|
|
|
.B SXE_EPERM
|
2015-08-05 01:23:16 +03:00
|
|
|
will be returned if permission was denied.
|
|
|
|
|
.br
|
2015-11-10 23:17:39 +02:00
|
|
|
.B SXE_LINKERROR
|
2015-08-05 01:23:16 +03:00
|
|
|
or
|
2015-11-10 23:17:39 +02:00
|
|
|
.B SXE_LINKBROKEN
|
2015-08-05 01:23:16 +03:00
|
|
|
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
|
2015-10-27 00:20:44 +02:00
|
|
|
.BI sxhub_set_rpcvalidator(3)
|
2015-08-05 01:23:16 +03:00
|
|
|
,
|
2015-11-10 23:17:39 +02:00
|
|
|
.BI sxlink_connect(3)
|
2015-08-05 01:23:16 +03:00
|
|
|
,
|
2015-11-10 23:17:39 +02:00
|
|
|
.BI sxlink_close(3)
|
2015-08-05 01:23:16 +03:00
|
|
|
.SH COPYRIGHT
|
2015-12-29 22:42:52 +02:00
|
|
|
This software licensed under GNU LGPL v3. See COPYING for further details.
|
2015-08-05 01:23:16 +03:00
|
|
|
.br
|
|
|
|
|
(c) Askele Group 2013-2015 <http://askele.com>
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
Alexander Vdolainen (vdo@askele.com)
|
