libcm is a C development framework with an emphasis on audio signal processing applications.
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.

cmUdpPort.h 5.8KB

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