CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_Fct_Pipe.h
Go to the documentation of this file.
1 //*********************************************************
2 // File: CLC_Fct_Pipe.h
3 // Project: CopperLan CHAILink Client SDK
4 // Version: 1.3
5 // Release Date: 2014/04/15
6 //*********************************************************
7 
8 /********************************************************************
9 Software License Agreement: CHAILink Client source code
10 
11 The software supplied herewith by Klavis Technology (the “Company”) is intended and
12 supplied to you, the Company’s customer, for use solely and exclusively on embedded
13 CopperLan products needing a CHAILink Client.
14  The software is owned by the Company and/or its supplier, and is protected
15  under applicable copyright laws. All rights are reserved. Any use in violation of the
16  foregoing restrictions may subject the user to criminal sanctions under applicable laws,
17 as well as to civil liability for the breach of the terms and conditions of this license.
18 
19 THIS SOFTWARE MUST REMAIN UNMODIFIED. NO WARRANTIES, WHETHER EXPRESS,
20  IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
21  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE
22 IN CASE OF SOURCE CODE CHANGE BY THE CUSTOMER. IN CASE OF SUCH CHANGE, THE
23 COMPANY SHALL NOT BE LIABLE FOR SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
24 OF ANY KIND.
25 ********************************************************************/
26 
27 #ifndef _CLC_FCT_PIPE_H_
28 #define _CLC_FCT_PIPE_H_
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
40 
43 
44 #if defined(ENABLE_PIPE)
52  CPHOBJECT const hPipe);
53 
59  CPHOBJECT const hPipe);
60 
61 #endif // defined(ENABLE_PIPE)
62 
66 
74  CPHOBJECT const hPipe,
75  CPPIPEINFO * const pPipeInfo);
77 
83 
89  CPHOBJECT const hPipe);
90 
102  CPHOBJECT const hPipe,
103  CPENDPOINT const * const pPeer);
104 
112  CPHOBJECT const hPipe,
113  CPENDPOINT const * const pPeer);
114 
122  CPHOBJECT const hPipe,
123  CPUINT16 const wConnectionIndex);
124 
132  CPHOBJECT const hPipe,
133  CPUINT16 const wConnectionIndex,
134  CPENDPOINT * const pPeer);
136 
139 
147  CPHOBJECT const hPipe,
148  CPBOOLEAN * const pfIsReady);
149 
160  CPHOBJECT const hPipe,
161  CPHOOKEDOBJECT const hMessage,
162  CPBOOLEAN const fFlush);
163 
169  CPHOBJECT const hPipe);
170 
185  CPHOBJECT const hPipe,
186  CPUINT16 const wSignalNumber,
187  CPUINT16 const wOptionalData0,
188  CPUINT16 const wOptionalData1,
189  CPUINT16 const wOptionalData2,
190  CPUINT16 const wOptionalData3,
191  CPCHAR8 const * const utf8OptionalData,
192  CPENDPOINT const * const pOptionalEndPoint);
193 
204  CPHOBJECT const hPipe,
205  CPMODIFIERMSG const * const pMessageData,
206  CPBOOLEAN const fFlush);
207 
218  CPHOBJECT const hPipe,
219  CPEVENTMSG const * const pMessageData,
220  CPBOOLEAN const fFlush);
221 
232  CPHOBJECT const hPipe,
233  CPSELECTORMSG const * const pMessageData,
234  CPBOOLEAN const fFlush);
235 
246  CPHOBJECT const hPipe,
247  CPTEXTMSG const * const pMessageData,
248  CPBOOLEAN const fFlush);
249 
256  CPHOBJECT const hPipe);
257 
259 
261 
262 #ifdef __cplusplus
263 }
264 #endif
265 
266 #endif // _CLC_FCT_PIPE_H_
CLC_ErrorCode Pipe_SendEventMessage(CPHOBJECT const hPipe, CPEVENTMSG const *const pMessageData, CPBOOLEAN const fFlush)
Send a event message. For performance, this function does not wait for a response.
CLC_ErrorCode Pipe_RemoveConnectionByIndex(CPHOBJECT const hPipe, CPUINT16 const wConnectionIndex)
Remove a connection by index.
#define CLC_SDK_API
Definition: CLCm_Platform.h:37
CLC_ErrorCode Pipe_SendSelectorMessage(CPHOBJECT const hPipe, CPSELECTORMSG const *const pMessageData, CPBOOLEAN const fFlush)
Send an event message. For performance, this function does not wait for a response.
CPUINT32 CPHOOKEDOBJECT
Handle on Hooked Object.
Definition: CLCm_Types.h:58
This structure stores data from a text message.
Definition: CLC_Fct_TextMessage.h:55
CLC_ErrorCode
Error code Enumeration. Error codes from 0x01 to 0xFF are related to a CopperLan functions return cod...
Definition: CLCm_Defines.h:469
CLC_ErrorCode Pipe_SendModifierMessage(CPHOBJECT const hPipe, CPMODIFIERMSG const *const pMessageData, CPBOOLEAN const fFlush)
Send a modifier message. For performance, this function does not wait for a response.
This structure stores data from an event message.
Definition: CLC_Fct_EventMessage.h:57
char CPCHAR8
Character Type (8 bit signed)
Definition: PlatformTypes.h:66
CLC_ErrorCode Pipe_AddConnection(CPHOBJECT const hPipe, CPENDPOINT const *const pPeer)
Add a connection.
This structure stores data from a modifier message.
Definition: CLC_Fct_ModifierMessage.h:61
CLC_ErrorCode Pipe_SendTextMessage(CPHOBJECT const hPipe, CPTEXTMSG const *const pMessageData, CPBOOLEAN const fFlush)
Send a text message. For performance, this function does not wait for a response. ...
This structure contains information for a specific pipe.
Definition: CLC_Types.h:171
unsigned short CPUINT16
Word Integer (16 bit unsigned)
Definition: PlatformTypes.h:45
CLC_ErrorCode Pipe_RemoveConnection(CPHOBJECT const hPipe, CPENDPOINT const *const pPeer)
Remove a connection.
CLC_ErrorCode Pipe_Signal(CPHOBJECT const hPipe, CPUINT16 const wSignalNumber, CPUINT16 const wOptionalData0, CPUINT16 const wOptionalData1, CPUINT16 const wOptionalData2, CPUINT16 const wOptionalData3, CPCHAR8 const *const utf8OptionalData, CPENDPOINT const *const pOptionalEndPoint)
Send a multicast signal directed to all devices present in the peer set.
Container structure for Endpoint.
Definition: CLC_Types.h:48
CLC_ErrorCode Pipe_IsReadyToSend(CPHOBJECT const hPipe, CPBOOLEAN *const pfIsReady)
Check if the Pipe is ready to send.
This structure stores data from a selector message.
Definition: CLC_Fct_SelectorMessage.h:64
CLC_ErrorCode Pipe_RegisterNotificationHandler(CPHOBJECT const hPipe)
Register notification handler for a pipe.
CLC_ErrorCode Pipe_ClearConnections(CPHOBJECT const hPipe)
Clear connections.
CPUINT32 CPHOBJECT
Handle on Object.
Definition: CLCm_Types.h:57
CLC_ErrorCode Pipe_Send(CPHOBJECT const hPipe, CPHOOKEDOBJECT const hMessage, CPBOOLEAN const fFlush)
Send a message with flush control, allowing multipart messages.
CLC_ErrorCode Pipe_DataConsumed(CPHOBJECT const hPipe)
Tells the sources that incoming SysEx or DataTransfer message has been processed. If this command is ...
CLC_ErrorCode Pipe_UnregisterNotificationHandler(CPHOBJECT const hPipe)
Unregister notification handler for a pipe.
CLC_ErrorCode Pipe_Flush(CPHOBJECT const hPipe)
Send pending messages.
CLC_ErrorCode Pipe_GetPipeInfo(CPHOBJECT const hPipe, CPPIPEINFO *const pPipeInfo)
Get pipe Informations.
CLC_ErrorCode Pipe_GetConnection(CPHOBJECT const hPipe, CPUINT16 const wConnectionIndex, CPENDPOINT *const pPeer)
Get a connection by index.