pingpong.h 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150
  1. #ifndef HEADER_CURL_PINGPONG_H
  2. #define HEADER_CURL_PINGPONG_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
  11. *
  12. * This software is licensed as described in the file COPYING, which
  13. * you should have received as part of this distribution. The terms
  14. * are also available at https://curl.haxx.se/docs/copyright.html.
  15. *
  16. * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17. * copies of the Software, and permit persons to whom the Software is
  18. * furnished to do so, under the terms of the COPYING file.
  19. *
  20. * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21. * KIND, either express or implied.
  22. *
  23. ***************************************************************************/
  24. #include "curl_setup.h"
  25. #if !defined(CURL_DISABLE_IMAP) || !defined(CURL_DISABLE_FTP) || \
  26. !defined(CURL_DISABLE_POP3) || !defined(CURL_DISABLE_SMTP)
  27. #define USE_PINGPONG
  28. #endif
  29. /* forward-declaration, this is defined in urldata.h */
  30. struct connectdata;
  31. typedef enum {
  32. FTPTRANSFER_BODY, /* yes do transfer a body */
  33. FTPTRANSFER_INFO, /* do still go through to get info/headers */
  34. FTPTRANSFER_NONE, /* don't get anything and don't get info */
  35. FTPTRANSFER_LAST /* end of list marker, never used */
  36. } curl_pp_transfer;
  37. /*
  38. * 'pingpong' is the generic struct used for protocols doing server<->client
  39. * conversations in a back-and-forth style such as FTP, IMAP, POP3, SMTP etc.
  40. *
  41. * It holds response cache and non-blocking sending data.
  42. */
  43. struct pingpong {
  44. char *cache; /* data cache between getresponse()-calls */
  45. size_t cache_size; /* size of cache in bytes */
  46. size_t nread_resp; /* number of bytes currently read of a server response */
  47. char *linestart_resp; /* line start pointer for the server response
  48. reader function */
  49. bool pending_resp; /* set TRUE when a server response is pending or in
  50. progress, and is cleared once the last response is
  51. read */
  52. char *sendthis; /* allocated pointer to a buffer that is to be sent to the
  53. server */
  54. size_t sendleft; /* number of bytes left to send from the sendthis buffer */
  55. size_t sendsize; /* total size of the sendthis buffer */
  56. struct curltime response; /* set to Curl_now() when a command has been sent
  57. off, used to time-out response reading */
  58. long response_time; /* When no timeout is given, this is the amount of
  59. milliseconds we await for a server response. */
  60. struct connectdata *conn; /* points to the connectdata struct that this
  61. belongs to */
  62. /* Function pointers the protocols MUST implement and provide for the
  63. pingpong layer to function */
  64. CURLcode (*statemach_act)(struct connectdata *conn);
  65. bool (*endofresp)(struct connectdata *conn, char *ptr, size_t len,
  66. int *code);
  67. };
  68. /*
  69. * Curl_pp_statemach()
  70. *
  71. * called repeatedly until done. Set 'wait' to make it wait a while on the
  72. * socket if there's no traffic.
  73. */
  74. CURLcode Curl_pp_statemach(struct pingpong *pp, bool block,
  75. bool disconnecting);
  76. /* initialize stuff to prepare for reading a fresh new response */
  77. void Curl_pp_init(struct pingpong *pp);
  78. /* Returns timeout in ms. 0 or negative number means the timeout has already
  79. triggered */
  80. time_t Curl_pp_state_timeout(struct pingpong *pp, bool disconnecting);
  81. /***********************************************************************
  82. *
  83. * Curl_pp_sendf()
  84. *
  85. * Send the formatted string as a command to a pingpong server. Note that
  86. * the string should not have any CRLF appended, as this function will
  87. * append the necessary things itself.
  88. *
  89. * made to never block
  90. */
  91. CURLcode Curl_pp_sendf(struct pingpong *pp,
  92. const char *fmt, ...);
  93. /***********************************************************************
  94. *
  95. * Curl_pp_vsendf()
  96. *
  97. * Send the formatted string as a command to a pingpong server. Note that
  98. * the string should not have any CRLF appended, as this function will
  99. * append the necessary things itself.
  100. *
  101. * made to never block
  102. */
  103. CURLcode Curl_pp_vsendf(struct pingpong *pp,
  104. const char *fmt,
  105. va_list args);
  106. /*
  107. * Curl_pp_readresp()
  108. *
  109. * Reads a piece of a server response.
  110. */
  111. CURLcode Curl_pp_readresp(curl_socket_t sockfd,
  112. struct pingpong *pp,
  113. int *code, /* return the server code if done */
  114. size_t *size); /* size of the response */
  115. CURLcode Curl_pp_flushsend(struct pingpong *pp);
  116. /* call this when a pingpong connection is disconnected */
  117. CURLcode Curl_pp_disconnect(struct pingpong *pp);
  118. int Curl_pp_getsock(struct pingpong *pp, curl_socket_t *socks);
  119. /***********************************************************************
  120. *
  121. * Curl_pp_moredata()
  122. *
  123. * Returns whether there are still more data in the cache and so a call
  124. * to Curl_pp_readresp() will not block.
  125. */
  126. bool Curl_pp_moredata(struct pingpong *pp);
  127. #endif /* HEADER_CURL_PINGPONG_H */