CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLCm_Transport.h
Go to the documentation of this file.
1 //*********************************************************
2 // File: CLCm_Transport.h
3 // Project: CopperLan CHAILink SDK Common Part
4 // For Client & Server
5 // Version: 1.3
6 // Release Date: 2014/04/15
7 //*********************************************************
8 
9 /********************************************************************
10 Software License Agreement: CHAILink Client source code
11 
12 The software supplied herewith by Klavis Technology (the “Company”) is intended and
13 supplied to you, the Company’s customer, for use solely and exclusively on embedded
14 CopperLan products needing a CHAILink Client.
15  The software is owned by the Company and/or its supplier, and is protected
16  under applicable copyright laws. All rights are reserved. Any use in violation of the
17  foregoing restrictions may subject the user to criminal sanctions under applicable laws,
18 as well as to civil liability for the breach of the terms and conditions of this license.
19 
20 THIS SOFTWARE MUST REMAIN UNMODIFIED. NO WARRANTIES, WHETHER EXPRESS,
21  IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
22  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE
23 IN CASE OF SOURCE CODE CHANGE BY THE CUSTOMER. IN CASE OF SUCH CHANGE, THE
24 COMPANY SHALL NOT BE LIABLE FOR SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
25 OF ANY KIND.
26 ********************************************************************/
27 
28 #ifndef __CLCM_TRANSPORT_H__
29 #define __CLCM_TRANSPORT_H__
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
38 
45 typedef void (*CLT_STATUSCHANGECB)( CPBOOLEAN fTransportIsAvailable, void *pCBParam );
46 
53 typedef void (*CLT_RECEIVE)( CPBYTE* pbBuffer, CPUINT16 wBufferSize, void *pCBParam);
54 
62 typedef CPBOOLEAN (*CLT_WRITE)( CPBYTE* pbBuffer, CPUINT16 wBufferSize, CPUINT16 * pwWritten, void * pTransportParam);
63 
68 typedef void (*CLT_DOPROCESS)(void * pTransportParam);
69 
78 typedef CPBOOLEAN (*CLT_SETCB)( CLT_RECEIVE pfnReceive, CLT_STATUSCHANGECB pfnStatusChange, void *pTransportParam, void *pCBParam);
79 
82 typedef struct
83 {
87  void * pTransportParam;
89 
91 
92 #ifdef __cplusplus
93 }
94 #endif
95 
96 #endif // __CLCM_TRANSPORT_H__
void(* CLT_RECEIVE)(CPBYTE *pbBuffer, CPUINT16 wBufferSize, void *pCBParam)
Data Reception Handler.
Definition: CLCm_Transport.h:53
CLT_SETCB pfnSetCallbacks
Set Transport Protocol interface function.
Definition: CLCm_Transport.h:86
void(* CLT_DOPROCESS)(void *pTransportParam)
Transport DoProcess Function.
Definition: CLCm_Transport.h:68
CPBOOLEAN(* CLT_WRITE)(CPBYTE *pbBuffer, CPUINT16 wBufferSize, CPUINT16 *pwWritten, void *pTransportParam)
Transport Write Function.
Definition: CLCm_Transport.h:62
CLT_WRITE pfnWrite
Transport write function (send data to peer)
Definition: CLCm_Transport.h:84
unsigned short CPUINT16
Word Integer (16 bit unsigned)
Definition: PlatformTypes.h:45
void * pTransportParam
Transport custom param : Passed back when Transport Protocol calls Transport (see pTransportParam in ...
Definition: CLCm_Transport.h:87
CPBOOLEAN(* CLT_SETCB)(CLT_RECEIVE pfnReceive, CLT_STATUSCHANGECB pfnStatusChange, void *pTransportParam, void *pCBParam)
Transport Set Callbacks.
Definition: CLCm_Transport.h:78
CLT_DOPROCESS pfnDoProcess
Transport DoProcess function (called repeatedly by the CHAILink)
Definition: CLCm_Transport.h:85
void(* CLT_STATUSCHANGECB)(CPBOOLEAN fTransportIsAvailable, void *pCBParam)
Transport Status Change Handler.
Definition: CLCm_Transport.h:45
CHAI Link Transport Interface.
Definition: CLCm_Transport.h:82