libcm is a C development framework with an emphasis on audio signal processing applications.
Du kannst nicht mehr als 25 Themen auswählen Themen müssen mit entweder einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.

cmUdpPort.h 5.6KB

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