XBinder  Version 2.9.x
rtxStreamSocket.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2003-2022 Objective Systems, Inc.
3  *
4  * This software is furnished under a license and may be used and copied
5  * only in accordance with the terms of such license and with the
6  * inclusion of the above copyright notice. This software or any other
7  * copies thereof may not be provided or otherwise made available to any
8  * other person. No title to and ownership of the software is hereby
9  * transferred.
10  *
11  * The information in this software is subject to change without notice
12  * and should not be construed as a commitment by Objective Systems, Inc.
13  *
14  * PROPRIETARY NOTICE
15  *
16  * This software is an unpublished work subject to a confidentiality agreement
17  * and is protected by copyright and trade secret law. Unauthorized copying,
18  * redistribution or other use of this work is prohibited.
19  *
20  * The above notice of copyright on this source code product does not indicate
21  * any actual or intended publication of such source code.
22  *
23  *****************************************************************************/
27 #ifndef _RTXSTREAMSOCKET_H_
28 #define _RTXSTREAMSOCKET_H_
29 
30 #ifndef _OS_NOSOCKET
31 
32 #ifndef _NO_STREAM
33 
34 #include "rtxsrc/rtxStream.h"
35 #include "rtxsrc/rtxSocket.h"
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
60 EXTERNRT int rtxStreamSocketAttach
61 (OSCTXT* pctxt, OSRTSOCKET socket, OSUINT16 flags);
62 
71 EXTERNRT int rtxStreamSocketClose (OSCTXT* pctxt);
72 
83 EXTERNRT int rtxStreamSocketCreateWriter
84 (OSCTXT* pctxt, const char* host, int port);
85 
97 EXTERNRT int rtxStreamSocketSetOwnership (OSCTXT* pctxt, OSBOOL ownSocket);
98 
110 EXTERNRT int rtxStreamSocketSetReadTimeout (OSCTXT* pctxt, OSUINT32 nsecs);
111 
112 #ifdef __cplusplus
113 }
114 #endif
115 
119 #endif /* _OS_NOSOCKET */
120 
121 #endif /* _NO_STREAM */
122 #endif /* _RTXSTREAMSOCKET_H_ */
EXTERNRT int rtxStreamSocketCreateWriter(OSCTXT *pctxt, const char *host, int port)
This function opens a socket stream for writing.
int OSRTSOCKET
Socket handle type definition.
Definition: rtxSocket.h:65
EXTERNRT int rtxStreamSocketClose(OSCTXT *pctxt)
This function closes a socket stream.
EXTERNRT int rtxStreamSocketAttach(OSCTXT *pctxt, OSRTSOCKET socket, OSUINT16 flags)
Attaches the existing socket handle to the stream.
Input/output data stream type definitions and function prototypes.
Run-time context structure.
Definition: rtxContext.h:198
EXTERNRT int rtxStreamSocketSetReadTimeout(OSCTXT *pctxt, OSUINT32 nsecs)
This function sets the read timeout value to the given number of seconds.
EXTERNRT int rtxStreamSocketSetOwnership(OSCTXT *pctxt, OSBOOL ownSocket)
This function transfers ownership of the socket to or from the stream instance.