cml/libcm
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

cmUdpNet.h: Comment updates.

Browse Source
This commit is contained in:
kevin 2013-04-08 23:09:27 -07:00
parent cb693a1c8e
commit f8e504cbfc
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
cmUdpNet.h
View File

@ -55,6 +55,10 @@ cmUnRC_t cmUdpNetAllocJson(
cmUnRC_t cmUdpNetFree( cmUdpNetH_t* hp ); cmUnRC_t cmUdpNetFree( cmUdpNetH_t* hp );
// Initialize a UDP net using a previously allocated handle // Initialize a UDP net using a previously allocated handle
// The node information (nodeLabel,nodeId,nodeSocketPort) refers
// to the local node. The callback information (cbFunc,cbArg)
// are used during cmUdpNetReceive() to receive incoming
// information from the local node.
cmUnRC_t cmUdpNetInit( cmUnRC_t cmUdpNetInit(
cmUdpNetH_t h, cmUdpNetH_t h,
const cmChar_t* nodeLabel, const cmChar_t* nodeLabel,
@ -118,8 +122,8 @@ cmUnRC_t cmUdpNetSendById( cmUdpNetH_t h, unsigned remoteNodeId, const void*
cmUnRC_t cmUdpNetSendByLabel( cmUdpNetH_t h, const cmChar_t* remoteNodeLabel, const void* data, unsigned dataByteCnt ); cmUnRC_t cmUdpNetSendByLabel( cmUdpNetH_t h, const cmChar_t* remoteNodeLabel, const void* data, unsigned dataByteCnt );
// Transmit any waiting incoming messages to the client via the // Transmit any waiting incoming messages to the client via the
// cmUdpNetCallback_t callback function provided in the UDP // cmUdpNetCallback_t callback function provided
// network's initialization function. // cmUdpNetInit().
// On input *msgCntPtr should hold the max. number of // On input *msgCntPtr should hold the max. number of
// messages to receive or NULL to receive all available. // messages to receive or NULL to receive all available.
// On return *msgCntPtr is set to the actual number of // On return *msgCntPtr is set to the actual number of