CLC_Fct_Pipe.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Fct_Pipe.h
// Project:         CopperLan CHAILink Client SDK
// Version:         1.3
// Release Date:    2014/04/15
//*********************************************************

/********************************************************************
Software License Agreement:  CHAILink Client source code

The software supplied herewith by Klavis Technology (the “Company”) is intended and
supplied to you, the Company’s customer, for use solely and exclusively on embedded
CopperLan products needing a CHAILink Client. 
 The software is owned by the Company and/or its supplier, and is protected 
 under applicable copyright laws. All rights are reserved. Any use in violation of the 
 foregoing restrictions may subject the user to criminal sanctions under applicable laws,
as well as to civil liability for the breach of the terms and conditions of this license.

THIS SOFTWARE MUST REMAIN UNMODIFIED. NO WARRANTIES, WHETHER EXPRESS, 
 IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF 
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE
IN CASE OF SOURCE CODE CHANGE BY THE CUSTOMER. IN CASE OF SUCH CHANGE, THE
COMPANY SHALL NOT BE LIABLE FOR SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
OF ANY KIND.
********************************************************************/

#ifndef _CLC_FCT_PIPE_H_
#define _CLC_FCT_PIPE_H_

#ifdef __cplusplus
extern "C" {
#endif



#if defined(ENABLE_PIPE)
CLC_SDK_API CLC_ErrorCode Pipe_RegisterNotificationHandler(
    CPHOBJECT const hPipe);

CLC_SDK_API CLC_ErrorCode Pipe_UnregisterNotificationHandler(
    CPHOBJECT const hPipe);

#endif // defined(ENABLE_PIPE)


CLC_SDK_API CLC_ErrorCode Pipe_GetPipeInfo(
    CPHOBJECT const hPipe, 
    CPPIPEINFO * const pPipeInfo);


CLC_SDK_API CLC_ErrorCode Pipe_ClearConnections(
    CPHOBJECT const hPipe);

CLC_SDK_API CLC_ErrorCode Pipe_AddConnection(
    CPHOBJECT const hPipe, 
    CPENDPOINT const * const pPeer);

CLC_SDK_API CLC_ErrorCode Pipe_RemoveConnection(
    CPHOBJECT const hPipe, 
    CPENDPOINT const * const pPeer);

CLC_SDK_API CLC_ErrorCode Pipe_RemoveConnectionByIndex(
    CPHOBJECT const hPipe, 
    CPUINT16 const wConnectionIndex);

CLC_SDK_API CLC_ErrorCode Pipe_GetConnection(
    CPHOBJECT const hPipe, 
    CPUINT16 const wConnectionIndex, 
    CPENDPOINT * const pPeer);


CLC_SDK_API CLC_ErrorCode Pipe_IsReadyToSend(
    CPHOBJECT const hPipe, 
    CPBOOLEAN * const pfIsReady);

CLC_SDK_API CLC_ErrorCode Pipe_Send(
    CPHOBJECT const hPipe, 
    CPHOOKEDOBJECT const hMessage, 
    CPBOOLEAN const fFlush);

CLC_SDK_API CLC_ErrorCode Pipe_Flush(
    CPHOBJECT const hPipe);

CLC_SDK_API 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);

CLC_SDK_API CLC_ErrorCode Pipe_SendModifierMessage(
    CPHOBJECT const hPipe, 
    CPMODIFIERMSG const * const pMessageData, 
    CPBOOLEAN const fFlush);

CLC_SDK_API CLC_ErrorCode Pipe_SendEventMessage(
    CPHOBJECT const hPipe,
    CPEVENTMSG const * const pMessageData, 
    CPBOOLEAN const fFlush);

CLC_SDK_API CLC_ErrorCode Pipe_SendSelectorMessage(
    CPHOBJECT const hPipe, 
    CPSELECTORMSG const * const pMessageData, 
    CPBOOLEAN const fFlush);

CLC_SDK_API CLC_ErrorCode Pipe_SendTextMessage(
    CPHOBJECT const hPipe, 
    CPTEXTMSG const * const pMessageData, 
    CPBOOLEAN const fFlush);

CLC_SDK_API CLC_ErrorCode Pipe_DataConsumed(
    CPHOBJECT const hPipe);



#ifdef __cplusplus
}
#endif

#endif // _CLC_FCT_PIPE_H_