hloop.h 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512
  1. #ifndef HV_LOOP_H_
  2. #define HV_LOOP_H_
  3. #include "hexport.h"
  4. #include "hplatform.h"
  5. #include "hdef.h"
  6. #include "hssl.h"
  7. typedef struct hloop_s hloop_t;
  8. typedef struct hevent_s hevent_t;
  9. // NOTE: The following structures are subclasses of hevent_t,
  10. // inheriting hevent_t data members and function members.
  11. typedef struct hidle_s hidle_t;
  12. typedef struct htimer_s htimer_t;
  13. typedef struct htimeout_s htimeout_t;
  14. typedef struct hperiod_s hperiod_t;
  15. typedef struct hio_s hio_t;
  16. typedef void (*hevent_cb) (hevent_t* ev);
  17. typedef void (*hidle_cb) (hidle_t* idle);
  18. typedef void (*htimer_cb) (htimer_t* timer);
  19. typedef void (*hio_cb) (hio_t* io);
  20. typedef void (*haccept_cb) (hio_t* io);
  21. typedef void (*hconnect_cb) (hio_t* io);
  22. typedef void (*hread_cb) (hio_t* io, void* buf, int readbytes);
  23. typedef void (*hwrite_cb) (hio_t* io, const void* buf, int writebytes);
  24. typedef void (*hclose_cb) (hio_t* io);
  25. typedef enum {
  26. HLOOP_STATUS_STOP,
  27. HLOOP_STATUS_RUNNING,
  28. HLOOP_STATUS_PAUSE
  29. } hloop_status_e;
  30. typedef enum {
  31. HEVENT_TYPE_NONE = 0,
  32. HEVENT_TYPE_IO = 0x00000001,
  33. HEVENT_TYPE_TIMEOUT = 0x00000010,
  34. HEVENT_TYPE_PERIOD = 0x00000020,
  35. HEVENT_TYPE_TIMER = HEVENT_TYPE_TIMEOUT|HEVENT_TYPE_PERIOD,
  36. HEVENT_TYPE_IDLE = 0x00000100,
  37. HEVENT_TYPE_CUSTOM = 0x00000400, // 1024
  38. } hevent_type_e;
  39. #define HEVENT_LOWEST_PRIORITY (-5)
  40. #define HEVENT_LOW_PRIORITY (-3)
  41. #define HEVENT_NORMAL_PRIORITY 0
  42. #define HEVENT_HIGH_PRIORITY 3
  43. #define HEVENT_HIGHEST_PRIORITY 5
  44. #define HEVENT_PRIORITY_SIZE (HEVENT_HIGHEST_PRIORITY-HEVENT_LOWEST_PRIORITY+1)
  45. #define HEVENT_PRIORITY_INDEX(priority) (priority-HEVENT_LOWEST_PRIORITY)
  46. #define HEVENT_FLAGS \
  47. unsigned destroy :1; \
  48. unsigned active :1; \
  49. unsigned pending :1;
  50. #define HEVENT_FIELDS \
  51. hloop_t* loop; \
  52. hevent_type_e event_type; \
  53. uint64_t event_id; \
  54. hevent_cb cb; \
  55. void* userdata; \
  56. void* privdata; \
  57. struct hevent_s* pending_next; \
  58. int priority; \
  59. HEVENT_FLAGS
  60. // sizeof(struct hevent_s)=64 on x64
  61. struct hevent_s {
  62. HEVENT_FIELDS
  63. };
  64. #define hevent_set_priority(ev, prio) ((hevent_t*)(ev))->priority = prio
  65. #define hevent_set_userdata(ev, udata) ((hevent_t*)(ev))->userdata = (void*)udata
  66. #define hevent_loop(ev) (((hevent_t*)(ev))->loop)
  67. #define hevent_type(ev) (((hevent_t*)(ev))->event_type)
  68. #define hevent_id(ev) (((hevent_t*)(ev))->event_id)
  69. #define hevent_priority(ev) (((hevent_t*)(ev))->priority)
  70. #define hevent_userdata(ev) (((hevent_t*)(ev))->userdata)
  71. typedef enum {
  72. HIO_TYPE_UNKNOWN = 0,
  73. HIO_TYPE_STDIN = 0x00000001,
  74. HIO_TYPE_STDOUT = 0x00000002,
  75. HIO_TYPE_STDERR = 0x00000004,
  76. HIO_TYPE_STDIO = 0x0000000F,
  77. HIO_TYPE_FILE = 0x00000010,
  78. HIO_TYPE_IP = 0x00000100,
  79. HIO_TYPE_SOCK_RAW = 0x00000F00,
  80. HIO_TYPE_UDP = 0x00001000,
  81. HIO_TYPE_DTLS = 0x00010000,
  82. HIO_TYPE_SOCK_DGRAM = 0x000FF000,
  83. HIO_TYPE_TCP = 0x00100000,
  84. HIO_TYPE_SSL = 0x01000000,
  85. HIO_TYPE_TLS = HIO_TYPE_SSL,
  86. HIO_TYPE_SOCK_STREAM= 0x0FF00000,
  87. HIO_TYPE_SOCKET = 0x0FFFFF00,
  88. } hio_type_e;
  89. typedef enum {
  90. HIO_SERVER_SIDE = 0,
  91. HIO_CLIENT_SIDE = 1,
  92. } hio_side_e;
  93. #define HIO_DEFAULT_CONNECT_TIMEOUT 5000 // ms
  94. #define HIO_DEFAULT_CLOSE_TIMEOUT 60000 // ms
  95. #define HIO_DEFAULT_KEEPALIVE_TIMEOUT 75000 // ms
  96. #define HIO_DEFAULT_HEARTBEAT_INTERVAL 10000 // ms
  97. BEGIN_EXTERN_C
  98. // loop
  99. #define HLOOP_FLAG_RUN_ONCE 0x00000001
  100. #define HLOOP_FLAG_AUTO_FREE 0x00000002
  101. #define HLOOP_FLAG_QUIT_WHEN_NO_ACTIVE_EVENTS 0x00000004
  102. HV_EXPORT hloop_t* hloop_new(int flags DEFAULT(HLOOP_FLAG_AUTO_FREE));
  103. // WARN: Forbid to call hloop_free if HLOOP_FLAG_AUTO_FREE set.
  104. HV_EXPORT void hloop_free(hloop_t** pp);
  105. // NOTE: when no active events, loop will quit if HLOOP_FLAG_QUIT_WHEN_NO_ACTIVE_EVENTS set.
  106. HV_EXPORT int hloop_run(hloop_t* loop);
  107. // NOTE: hloop_stop called in loop-thread just set flag to quit in next loop,
  108. // if called in other thread, it will wakeup loop-thread from blocking poll system call,
  109. // then you should join loop thread to safely exit loop thread.
  110. HV_EXPORT int hloop_stop(hloop_t* loop);
  111. HV_EXPORT int hloop_pause(hloop_t* loop);
  112. HV_EXPORT int hloop_resume(hloop_t* loop);
  113. HV_EXPORT int hloop_wakeup(hloop_t* loop);
  114. HV_EXPORT hloop_status_e hloop_status(hloop_t* loop);
  115. HV_EXPORT void hloop_update_time(hloop_t* loop);
  116. HV_EXPORT uint64_t hloop_now(hloop_t* loop); // s
  117. HV_EXPORT uint64_t hloop_now_ms(hloop_t* loop); // ms
  118. HV_EXPORT uint64_t hloop_now_hrtime(hloop_t* loop); // us
  119. #define hloop_now_us hloop_now_hrtime
  120. // @return pid of hloop_run
  121. HV_EXPORT long hloop_pid(hloop_t* loop);
  122. // @return tid of hloop_run
  123. HV_EXPORT long hloop_tid(hloop_t* loop);
  124. // userdata
  125. HV_EXPORT void hloop_set_userdata(hloop_t* loop, void* userdata);
  126. HV_EXPORT void* hloop_userdata(hloop_t* loop);
  127. // custom_event
  128. /*
  129. * hevent_t ev;
  130. * memset(&ev, 0, sizeof(hevent_t));
  131. * ev.event_type = (hevent_type_e)(HEVENT_TYPE_CUSTOM + 1);
  132. * ev.cb = custom_event_cb;
  133. * ev.userdata = userdata;
  134. * hloop_post_event(loop, &ev);
  135. */
  136. // NOTE: hloop_post_event is thread-safe, used to post event from other thread to loop thread.
  137. HV_EXPORT void hloop_post_event(hloop_t* loop, hevent_t* ev);
  138. // idle
  139. HV_EXPORT hidle_t* hidle_add(hloop_t* loop, hidle_cb cb, uint32_t repeat DEFAULT(INFINITE));
  140. HV_EXPORT void hidle_del(hidle_t* idle);
  141. // timer
  142. // @param timeout: unit(ms)
  143. HV_EXPORT htimer_t* htimer_add(hloop_t* loop, htimer_cb cb, uint32_t timeout, uint32_t repeat DEFAULT(INFINITE));
  144. /*
  145. * minute hour day week month cb
  146. * 0~59 0~23 1~31 0~6 1~12
  147. * -1 -1 -1 -1 -1 cron.minutely
  148. * 30 -1 -1 -1 -1 cron.hourly
  149. * 30 1 -1 -1 -1 cron.daily
  150. * 30 1 15 -1 -1 cron.monthly
  151. * 30 1 -1 5 -1 cron.weekly
  152. * 30 1 1 -1 10 cron.yearly
  153. */
  154. HV_EXPORT htimer_t* htimer_add_period(hloop_t* loop, htimer_cb cb,
  155. int8_t minute DEFAULT(0), int8_t hour DEFAULT(-1), int8_t day DEFAULT(-1),
  156. int8_t week DEFAULT(-1), int8_t month DEFAULT(-1), uint32_t repeat DEFAULT(INFINITE));
  157. HV_EXPORT void htimer_del(htimer_t* timer);
  158. HV_EXPORT void htimer_reset(htimer_t* timer);
  159. // io
  160. //-----------------------low-level apis---------------------------------------
  161. #define HV_READ 0x0001
  162. #define HV_WRITE 0x0004
  163. #define HV_RDWR (HV_READ|HV_WRITE)
  164. /*
  165. const char* hio_engine() {
  166. #ifdef EVENT_SELECT
  167. return "select";
  168. #elif defined(EVENT_POLL)
  169. return "poll";
  170. #elif defined(EVENT_EPOLL)
  171. return "epoll";
  172. #elif defined(EVENT_KQUEUE)
  173. return "kqueue";
  174. #elif defined(EVENT_IOCP)
  175. return "iocp";
  176. #elif defined(EVENT_PORT)
  177. return "evport";
  178. #else
  179. return "noevent";
  180. #endif
  181. }
  182. */
  183. HV_EXPORT const char* hio_engine();
  184. HV_EXPORT hio_t* hio_get(hloop_t* loop, int fd);
  185. HV_EXPORT int hio_add(hio_t* io, hio_cb cb, int events DEFAULT(HV_READ));
  186. HV_EXPORT int hio_del(hio_t* io, int events DEFAULT(HV_RDWR));
  187. // NOTE: io detach from old loop and attach to new loop
  188. /* @see examples/multi-thread/one-acceptor-multi-workers.c
  189. void new_conn_event(hevent_t* ev) {
  190. hloop_t* loop = ev->loop;
  191. hio_t* io = (hio_t*)hevent_userdata(ev);
  192. hio_attach(loop, io);
  193. }
  194. void on_accpet(hio_t* io) {
  195. hio_detach(io);
  196. hloop_t* worker_loop = get_one_loop();
  197. hevent_t ev;
  198. memset(&ev, 0, sizeof(ev));
  199. ev.loop = worker_loop;
  200. ev.cb = new_conn_event;
  201. ev.userdata = io;
  202. hloop_post_event(worker_loop, &ev);
  203. }
  204. */
  205. HV_EXPORT void hio_detach(/*hloop_t* loop,*/ hio_t* io);
  206. HV_EXPORT void hio_attach(hloop_t* loop, hio_t* io);
  207. HV_EXPORT bool hio_exists(hloop_t* loop, int fd);
  208. // hio_t fields
  209. // NOTE: fd cannot be used as unique identifier, so we provide an id.
  210. HV_EXPORT uint32_t hio_id (hio_t* io);
  211. HV_EXPORT int hio_fd (hio_t* io);
  212. HV_EXPORT int hio_error (hio_t* io);
  213. HV_EXPORT int hio_events (hio_t* io);
  214. HV_EXPORT int hio_revents (hio_t* io);
  215. HV_EXPORT hio_type_e hio_type (hio_t* io);
  216. HV_EXPORT struct sockaddr* hio_localaddr(hio_t* io);
  217. HV_EXPORT struct sockaddr* hio_peeraddr (hio_t* io);
  218. HV_EXPORT void hio_set_context(hio_t* io, void* ctx);
  219. HV_EXPORT void* hio_context(hio_t* io);
  220. HV_EXPORT bool hio_is_opened(hio_t* io);
  221. HV_EXPORT bool hio_is_closed(hio_t* io);
  222. HV_EXPORT size_t hio_read_bufsize(hio_t* io);
  223. HV_EXPORT size_t hio_write_bufsize(hio_t* io);
  224. // set callbacks
  225. HV_EXPORT void hio_setcb_accept (hio_t* io, haccept_cb accept_cb);
  226. HV_EXPORT void hio_setcb_connect (hio_t* io, hconnect_cb connect_cb);
  227. HV_EXPORT void hio_setcb_read (hio_t* io, hread_cb read_cb);
  228. HV_EXPORT void hio_setcb_write (hio_t* io, hwrite_cb write_cb);
  229. HV_EXPORT void hio_setcb_close (hio_t* io, hclose_cb close_cb);
  230. // get callbacks
  231. HV_EXPORT haccept_cb hio_getcb_accept(hio_t* io);
  232. HV_EXPORT hconnect_cb hio_getcb_connect(hio_t* io);
  233. HV_EXPORT hread_cb hio_getcb_read(hio_t* io);
  234. HV_EXPORT hwrite_cb hio_getcb_write(hio_t* io);
  235. HV_EXPORT hclose_cb hio_getcb_close(hio_t* io);
  236. // some useful settings
  237. // Enable SSL/TLS is so easy :)
  238. HV_EXPORT int hio_enable_ssl(hio_t* io);
  239. HV_EXPORT bool hio_is_ssl(hio_t* io);
  240. HV_EXPORT hssl_t hio_get_ssl(hio_t* io);
  241. HV_EXPORT int hio_set_ssl(hio_t* io, hssl_t ssl);
  242. // NOTE: One loop per thread, one readbuf per loop.
  243. // But you can pass in your own readbuf instead of the default readbuf to avoid memcopy.
  244. HV_EXPORT void hio_set_readbuf(hio_t* io, void* buf, size_t len);
  245. // connect timeout => hclose_cb
  246. HV_EXPORT void hio_set_connect_timeout(hio_t* io, int timeout_ms DEFAULT(HIO_DEFAULT_CONNECT_TIMEOUT));
  247. // close timeout => hclose_cb
  248. HV_EXPORT void hio_set_close_timeout(hio_t* io, int timeout_ms DEFAULT(HIO_DEFAULT_CLOSE_TIMEOUT));
  249. // keepalive timeout => hclose_cb
  250. HV_EXPORT void hio_set_keepalive_timeout(hio_t* io, int timeout_ms DEFAULT(HIO_DEFAULT_KEEPALIVE_TIMEOUT));
  251. /*
  252. void send_heartbeat(hio_t* io) {
  253. static char buf[] = "PING\r\n";
  254. hio_write(io, buf, 6);
  255. }
  256. hio_set_heartbeat(io, 3000, send_heartbeat);
  257. */
  258. typedef void (*hio_send_heartbeat_fn)(hio_t* io);
  259. // heartbeat interval => hio_send_heartbeat_fn
  260. HV_EXPORT void hio_set_heartbeat(hio_t* io, int interval_ms, hio_send_heartbeat_fn fn);
  261. // Nonblocking, poll IO events in the loop to call corresponding callback.
  262. // hio_add(io, HV_READ) => accept => haccept_cb
  263. HV_EXPORT int hio_accept (hio_t* io);
  264. // connect => hio_add(io, HV_WRITE) => hconnect_cb
  265. HV_EXPORT int hio_connect(hio_t* io);
  266. // hio_add(io, HV_READ) => read => hread_cb
  267. HV_EXPORT int hio_read (hio_t* io);
  268. #define hio_read_start(io) hio_read(io)
  269. #define hio_read_stop(io) hio_del(io, HV_READ)
  270. // hio_read_start => hread_cb => hio_read_stop
  271. HV_EXPORT int hio_read_once (hio_t* io);
  272. HV_EXPORT int hio_read_until(hio_t* io, int len);
  273. // NOTE: hio_write is thread-safe, locked by recursive_mutex, allow to be called by other threads.
  274. // hio_try_write => hio_add(io, HV_WRITE) => write => hwrite_cb
  275. HV_EXPORT int hio_write (hio_t* io, const void* buf, size_t len);
  276. // NOTE: hio_close is thread-safe, hio_close_async will be called actually in other thread.
  277. // hio_del(io, HV_RDWR) => close => hclose_cb
  278. HV_EXPORT int hio_close (hio_t* io);
  279. // NOTE: hloop_post_event(hio_close_event)
  280. HV_EXPORT int hio_close_async(hio_t* io);
  281. //------------------high-level apis-------------------------------------------
  282. // hio_get -> hio_set_readbuf -> hio_setcb_read -> hio_read
  283. HV_EXPORT hio_t* hread (hloop_t* loop, int fd, void* buf, size_t len, hread_cb read_cb);
  284. // hio_get -> hio_setcb_write -> hio_write
  285. HV_EXPORT hio_t* hwrite (hloop_t* loop, int fd, const void* buf, size_t len, hwrite_cb write_cb DEFAULT(NULL));
  286. // hio_get -> hio_close
  287. HV_EXPORT void hclose (hloop_t* loop, int fd);
  288. // tcp
  289. // hio_get -> hio_setcb_accept -> hio_accept
  290. HV_EXPORT hio_t* haccept (hloop_t* loop, int listenfd, haccept_cb accept_cb);
  291. // hio_get -> hio_setcb_connect -> hio_connect
  292. HV_EXPORT hio_t* hconnect (hloop_t* loop, int connfd, hconnect_cb connect_cb);
  293. // hio_get -> hio_set_readbuf -> hio_setcb_read -> hio_read
  294. HV_EXPORT hio_t* hrecv (hloop_t* loop, int connfd, void* buf, size_t len, hread_cb read_cb);
  295. // hio_get -> hio_setcb_write -> hio_write
  296. HV_EXPORT hio_t* hsend (hloop_t* loop, int connfd, const void* buf, size_t len, hwrite_cb write_cb DEFAULT(NULL));
  297. // udp
  298. HV_EXPORT void hio_set_type(hio_t* io, hio_type_e type);
  299. HV_EXPORT void hio_set_localaddr(hio_t* io, struct sockaddr* addr, int addrlen);
  300. HV_EXPORT void hio_set_peeraddr (hio_t* io, struct sockaddr* addr, int addrlen);
  301. // NOTE: must call hio_set_peeraddr before hrecvfrom/hsendto
  302. // hio_get -> hio_set_readbuf -> hio_setcb_read -> hio_read
  303. HV_EXPORT hio_t* hrecvfrom (hloop_t* loop, int sockfd, void* buf, size_t len, hread_cb read_cb);
  304. // hio_get -> hio_setcb_write -> hio_write
  305. HV_EXPORT hio_t* hsendto (hloop_t* loop, int sockfd, const void* buf, size_t len, hwrite_cb write_cb DEFAULT(NULL));
  306. //-----------------top-level apis---------------------------------------------
  307. // @hio_create_socket: socket -> bind -> listen
  308. // sockaddr_set_ipport -> socket -> hio_get(loop, sockfd) ->
  309. // side == HIO_SERVER_SIDE ? bind ->
  310. // type & HIO_TYPE_SOCK_STREAM ? listen ->
  311. HV_EXPORT hio_t* hio_create_socket(hloop_t* loop, const char* host, int port,
  312. hio_type_e type DEFAULT(HIO_TYPE_TCP),
  313. hio_side_e side DEFAULT(HIO_SERVER_SIDE));
  314. // @tcp_server: hio_create_socket(loop, host, port, HIO_TYPE_TCP, HIO_SERVER_SIDE) -> hio_setcb_accept -> hio_accept
  315. // @see examples/tcp_echo_server.c
  316. HV_EXPORT hio_t* hloop_create_tcp_server (hloop_t* loop, const char* host, int port, haccept_cb accept_cb);
  317. // @tcp_client: hio_create_socket(loop, host, port, HIO_TYPE_TCP, HIO_CLIENT_SIDE) -> hio_setcb_connect -> hio_connect
  318. // @see examples/nc.c
  319. HV_EXPORT hio_t* hloop_create_tcp_client (hloop_t* loop, const char* host, int port, hconnect_cb connect_cb);
  320. // @ssl_server: hio_create_socket(loop, host, port, HIO_TYPE_SSL, HIO_SERVER_SIDE) -> hio_setcb_accept -> hio_accept
  321. // @see examples/tcp_echo_server.c => #define TEST_SSL 1
  322. HV_EXPORT hio_t* hloop_create_ssl_server (hloop_t* loop, const char* host, int port, haccept_cb accept_cb);
  323. // @ssl_client: hio_create_socket(loop, host, port, HIO_TYPE_SSL, HIO_CLIENT_SIDE) -> hio_setcb_connect -> hio_connect
  324. // @see examples/nc.c => #define TEST_SSL 1
  325. HV_EXPORT hio_t* hloop_create_ssl_client (hloop_t* loop, const char* host, int port, hconnect_cb connect_cb);
  326. // @udp_server: hio_create_socket(loop, host, port, HIO_TYPE_UDP, HIO_SERVER_SIDE)
  327. // @see examples/udp_echo_server.c
  328. HV_EXPORT hio_t* hloop_create_udp_server (hloop_t* loop, const char* host, int port);
  329. // @udp_server: hio_create_socket(loop, host, port, HIO_TYPE_UDP, HIO_CLIENT_SIDE)
  330. // @see examples/nc.c
  331. HV_EXPORT hio_t* hloop_create_udp_client (hloop_t* loop, const char* host, int port);
  332. //-----------------upstream---------------------------------------------
  333. // hio_read(io)
  334. // hio_read(io->upstream_io)
  335. HV_EXPORT void hio_read_upstream(hio_t* io);
  336. // hio_write(io->upstream_io, buf, bytes)
  337. HV_EXPORT void hio_write_upstream(hio_t* io, void* buf, int bytes);
  338. // hio_close(io->upstream_io)
  339. HV_EXPORT void hio_close_upstream(hio_t* io);
  340. // io1->upstream_io = io2;
  341. // io2->upstream_io = io1;
  342. // hio_setcb_read(io1, hio_write_upstream);
  343. // hio_setcb_read(io2, hio_write_upstream);
  344. HV_EXPORT void hio_setup_upstream(hio_t* io1, hio_t* io2);
  345. // @return io->upstream_io
  346. HV_EXPORT hio_t* hio_get_upstream(hio_t* io);
  347. // @tcp_upstream: hio_create -> hio_setup_upstream -> hio_setcb_close(hio_close_upstream) -> hconnect -> on_connect -> hio_read_upstream
  348. // @return upstream_io
  349. // @see examples/tcp_proxy_server
  350. HV_EXPORT hio_t* hio_setup_tcp_upstream(hio_t* io, const char* host, int port, int ssl DEFAULT(0));
  351. #define hio_setup_ssl_upstream(io, host, port) hio_setup_tcp_upstream(io, host, port, 1)
  352. // @udp_upstream: hio_create -> hio_setup_upstream -> hio_read_upstream
  353. // @return upstream_io
  354. // @see examples/udp_proxy_server
  355. HV_EXPORT hio_t* hio_setup_udp_upstream(hio_t* io, const char* host, int port);
  356. //-----------------unpack---------------------------------------------
  357. typedef enum {
  358. UNPACK_BY_FIXED_LENGTH = 1, // Not recommended
  359. UNPACK_BY_DELIMITER = 2, // Suitable for text protocol
  360. UNPACK_BY_LENGTH_FIELD = 3, // Suitable for binary protocol
  361. } unpack_mode_e;
  362. #define DEFAULT_PACKAGE_MAX_LENGTH (1 << 21) // 2M
  363. // UNPACK_BY_DELIMITER
  364. #define PACKAGE_MAX_DELIMITER_BYTES 8
  365. // UNPACK_BY_LENGTH_FIELD
  366. typedef enum {
  367. ENCODE_BY_VARINT = 17, // 1 MSB + 7 bits
  368. ENCODE_BY_LITTEL_ENDIAN = LITTLE_ENDIAN, // 1234
  369. ENCODE_BY_BIG_ENDIAN = BIG_ENDIAN, // 4321
  370. } unpack_coding_e;
  371. typedef struct unpack_setting_s {
  372. unpack_mode_e mode;
  373. unsigned int package_max_length;
  374. union {
  375. // UNPACK_BY_FIXED_LENGTH
  376. struct {
  377. unsigned int fixed_length;
  378. };
  379. // UNPACK_BY_DELIMITER
  380. struct {
  381. unsigned char delimiter[PACKAGE_MAX_DELIMITER_BYTES];
  382. unsigned short delimiter_bytes;
  383. };
  384. // UNPACK_BY_LENGTH_FIELD
  385. /* package_len = head_len + body_len + length_adjustment
  386. *
  387. * if (length_field_coding == ENCODE_BY_VARINT) head_len = body_offset + varint_bytes - length_field_bytes;
  388. * else head_len = body_offset;
  389. *
  390. * body_len calc by length_field
  391. *
  392. */
  393. struct {
  394. unsigned short body_offset;
  395. unsigned short length_field_offset;
  396. unsigned short length_field_bytes;
  397. short length_adjustment;
  398. unpack_coding_e length_field_coding;
  399. };
  400. };
  401. #ifdef __cplusplus
  402. unpack_setting_s() {
  403. // Recommended setting:
  404. // head = flags:1byte + length:4bytes = 5bytes
  405. mode = UNPACK_BY_LENGTH_FIELD;
  406. package_max_length = DEFAULT_PACKAGE_MAX_LENGTH;
  407. fixed_length = 0;
  408. delimiter_bytes = 0;
  409. body_offset = 5;
  410. length_field_offset = 1;
  411. length_field_bytes = 4;
  412. length_field_coding = ENCODE_BY_BIG_ENDIAN;
  413. length_adjustment = 0;
  414. }
  415. #endif
  416. } unpack_setting_t;
  417. HV_EXPORT void hio_set_unpack(hio_t* io, unpack_setting_t* setting);
  418. HV_EXPORT void hio_unset_unpack(hio_t* io);
  419. // unpack examples
  420. /*
  421. unpack_setting_t ftp_unpack_setting;
  422. memset(&ftp_unpack_setting, 0, sizeof(unpack_setting_t));
  423. ftp_unpack_setting.package_max_length = DEFAULT_PACKAGE_MAX_LENGTH;
  424. ftp_unpack_setting.mode = UNPACK_BY_DELIMITER;
  425. ftp_unpack_setting.delimiter[0] = '\r';
  426. ftp_unpack_setting.delimiter[1] = '\n';
  427. ftp_unpack_setting.delimiter_bytes = 2;
  428. unpack_setting_t mqtt_unpack_setting = {
  429. .mode = UNPACK_BY_LENGTH_FIELD,
  430. .package_max_length = DEFAULT_PACKAGE_MAX_LENGTH,
  431. .body_offset = 2,
  432. .length_field_offset = 1,
  433. .length_field_bytes = 1,
  434. .length_field_coding = ENCODE_BY_VARINT,
  435. };
  436. unpack_setting_t grpc_unpack_setting = {
  437. .mode = UNPACK_BY_LENGTH_FIELD,
  438. .package_max_length = DEFAULT_PACKAGE_MAX_LENGTH,
  439. .body_offset = 5,
  440. .length_field_offset = 1,
  441. .length_field_bytes = 4,
  442. .length_field_coding = ENCODE_BY_BIG_ENDIAN,
  443. };
  444. */
  445. END_EXTERN_C
  446. #endif // HV_LOOP_H_