Ver código fonte

cmUdpNet.h: Comment updates.

master
kevin 11 anos atrás
pai
commit
f8e504cbfc
1 arquivos alterados com 6 adições e 2 exclusões
  1. 6
    2
      cmUdpNet.h

+ 6
- 2
cmUdpNet.h Ver arquivo

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

Carregando…
Cancelar
Salvar