libcm is a C development framework with an emphasis on audio signal processing applications.
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.

cmUdpPort.h 5.8KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150
  1. #ifndef cmUdpPort_h
  2. #define cmUdpPort_h
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6. //( { file_desc:"UDP socket interface class." kw:[network] }
  7. #include <netinet/in.h>
  8. enum
  9. {
  10. kOkUdpRC = cmOkRC,
  11. kSockCreateFailUdpRC,
  12. kSockCloseFailUdpRC,
  13. kSockBindFailUdpRC,
  14. kSockConnectFailUdpRC,
  15. kSockOptSetFailUdpRC,
  16. kSockSendFailUdpRC,
  17. kSockRecvFailUdpRC,
  18. kSockSelectFailUdpRC,
  19. kPtoNFailUdpRC,
  20. kNtoPFailUdpRC,
  21. kNotConnectedUdpRC,
  22. kThreadFailUdpRC,
  23. kQueueFailUdpRC,
  24. kRecvBufOverflowUdpRC,
  25. kBufTooSmallUdpRC,
  26. kHostNameFailUdpRC,
  27. kInvalidPortNumbUdpRC,
  28. kTimeOutUdpRC,
  29. kTestFailUdpRC
  30. };
  31. typedef cmRC_t cmUdpRC_t;
  32. typedef cmHandle_t cmUdpH_t;
  33. typedef unsigned short cmUdpPort_t;
  34. extern cmUdpH_t cmUdpNullHandle;
  35. typedef void (*cmUdpCallback_t)( void* cbArg, const char* data, unsigned dataByteCnt, const struct sockaddr_in* fromAddr );
  36. enum
  37. {
  38. kNonBlockingUdpFl = 0x00,
  39. kBlockingUdpFl = 0x01,
  40. kNoQueueUdpFl = 0x02,
  41. kBroadcastUdpFl = 0x04
  42. };
  43. enum
  44. {
  45. // port 0 is reserved by and is therefore a convenient invalid port number
  46. kInvalidUdpPortNumber = 0
  47. };
  48. cmUdpRC_t cmUdpAlloc( cmCtx_t* ctx, cmUdpH_t* hp );
  49. cmUdpRC_t cmUdpFree( cmUdpH_t* hp );
  50. cmUdpRC_t cmUdpInit(
  51. cmUdpH_t h,
  52. cmUdpPort_t port, // this sockets port
  53. unsigned flags, // see kXXXUdpFl
  54. cmUdpCallback_t cbFunc, // Callback for use w/ cmUdpGetAvailData()
  55. void* cbArg, // First arg to cbFunc().
  56. const char* remoteAddr, // Remote addr to bind this socket to (or NULL).
  57. cmUdpPort_t remotePort, // Remote port to use with remoteAddr.
  58. unsigned recvBufByteCnt, // Size of the internal receive buffer in bytes. Size of the internal queue and msg receive buffer. No single msg can exceed this size.
  59. unsigned timeOutMs ); // Receive time-out in milliseconds
  60. cmUdpRC_t cmUdpFinal( cmUdpH_t h );
  61. bool cmUdpIsValid( cmUdpH_t h );
  62. // This function may not return a useful value until the
  63. // socket has gone into 'listen' mode.
  64. const struct sockaddr_in* cmUdpLocalAddr( cmUdpH_t h );
  65. // Set a destination address for this socket. Once a destination address is set
  66. // the caller may use cmUdpSend() to communicate with the specified remote socket
  67. // without having to specify an destination address on each call.
  68. cmUdpRC_t cmUdpConnect( cmUdpH_t h, const char* remoteAddr, cmUdpPort_t remotePort );
  69. // Send a message to a remote UDP socket. Use the function cmUdpInitAddr() to setup
  70. // the 'sockaddr_in' arg. for cmUdpSendTo().
  71. cmUdpRC_t cmUdpSend( cmUdpH_t h, const char* data, unsigned dataByteCnt );
  72. cmUdpRC_t cmUdpSendTo( cmUdpH_t h, const char* data, unsigned dataByteCnt, const struct sockaddr_in* remoteAddr );
  73. cmUdpRC_t cmUdpSend2( cmUdpH_t h, const char* data, unsigned dataByteCnt, const char* remoteAddr, cmUdpPort_t remotePort );
  74. // Receive incoming messages by directly checking the internal
  75. // socket for waiting data. This function is used to receive
  76. // incoming data when the internal listening thread is not used.
  77. // Note that if kBlockingUdpFl was set
  78. // in cmUdpInit() that this call will block for available data
  79. // or for 'timeOutMs' milliseconds, whichever comes first.
  80. // If kNonBlockingUdpFl was set in cmUdpInit() then the function
  81. // will return immediately if no incoming messages are waiting.
  82. // If non-NULL *recvByteCntPtr is set to the length of the received
  83. // message or 0 if no msg was received.
  84. cmUdpRC_t cmUdpRecv( cmUdpH_t h, char* data, unsigned dataByteCnt, struct sockaddr_in* fromAddr, unsigned* recvByteCntPtr );
  85. // Start a listening thread. If the queue is enabled then incoming
  86. // messages are received as they arrive and stored in an internal
  87. // queue until the client requests them using cmUdpGetAvailData().
  88. // If the queue is disabled the messages are transmitted immediately
  89. // to the client in the context of the internal listening thread.
  90. cmUdpRC_t cmUdpEnableListen( cmUdpH_t h, bool enableFl );
  91. // Enable/disable the internal queue. If the queue is disabled then
  92. // the receive callback function will be called immediately upon reception
  93. // of the incoming message in the context of the internal listening thread.
  94. // If the queue is enabled then incoming
  95. // messages will be queued until they are transmitted by calling
  96. // cmUdpGetAvailData().
  97. bool cmUdpIsQueueEnabled( cmUdpH_t h );
  98. void cmUdpQueueEnable( cmUdpH_t h, bool enableFl );
  99. // Return the size of the next available message waiting in the
  100. // internal data queue.
  101. unsigned cmUdpAvailDataByteCount( cmUdpH_t h );
  102. // The Call this function to receieve any data waiting in the internal queue.
  103. // Set 'data' to NULL to receive the data via the callback provided
  104. // in cmUdpAlloc().
  105. // On input *dataByteCntPtr must be set to the number of bytes in data[].
  106. // On return *dataByteCntPtr is set to the actual number of bytes copied into data[].
  107. // If fromAddr is non-NULL it is set to the data source address.
  108. cmUdpRC_t cmUdpGetAvailData( cmUdpH_t h, char* data, unsigned* dataByteCntPtr, struct sockaddr_in* fromAddr );
  109. void cmUdpReport( cmUdpH_t h, cmRpt_t* rpt );
  110. // Prepare a struct sockadddr_in for use with cmUdpSendTo()
  111. cmUdpRC_t cmUdpInitAddr( cmUdpH_t h, const char* addrStr, cmUdpPort_t portNumber, struct sockaddr_in* retAddrPtr );
  112. const cmChar_t* cmUdpAddrToString( cmUdpH_t h, const struct sockaddr_in* addr );
  113. bool cmUdpAddrIsEqual( const struct sockaddr_in* a0, const struct sockaddr_in* a1 );
  114. const cmChar_t* cmUdpHostName( cmUdpH_t h );
  115. cmUdpRC_t cmUdpTest( cmCtx_t* ctx, const char* remoteIpAddr, cmUdpPort_t port );
  116. cmUdpRC_t cmUdpTestV( cmCtx_t* ctx, unsigned argc, const char* argv[]);
  117. //)
  118. #ifdef __cplusplus
  119. }
  120. #endif
  121. #endif