libwebsockets
Lightweight C library for HTML5 websockets
lws-retry.h
1 /*
2  * libwebsockets - small server side websockets and web server implementation
3  *
4  * Copyright (C) 2010 - 2019 Andy Green <andy@warmcat.com>
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22  * IN THE SOFTWARE.
23  */
24 
25 typedef struct lws_retry_bo {
26  const uint32_t *retry_ms_table; /* base delay in ms */
27  uint16_t retry_ms_table_count; /* entries in table */
28  uint16_t conceal_count; /* max retries to conceal */
29  uint16_t secs_since_valid_ping; /* idle before PING issued */
30  uint16_t secs_since_valid_hangup; /* idle before hangup conn */
31  uint8_t jitter_percent; /* % additional random jitter */
33 
34 #define LWS_RETRY_CONCEAL_ALWAYS (0xffff)
35 
55 LWS_VISIBLE LWS_EXTERN unsigned int
56 lws_retry_get_delay_ms(struct lws_context *context, const lws_retry_bo_t *retry,
57  uint16_t *ctry, char *conceal);
58 
72 LWS_VISIBLE LWS_EXTERN int
73 lws_retry_sul_schedule(struct lws_context *context, int tid,
74  lws_sorted_usec_list_t *sul, const lws_retry_bo_t *retry,
75  sul_cb_t cb, uint16_t *ctry);
76 
93 LWS_VISIBLE LWS_EXTERN int
94 lws_retry_sul_schedule_retry_wsi(struct lws *wsi, lws_sorted_usec_list_t *sul,
95  sul_cb_t cb, uint16_t *ctry);
Definition: lws-retry.h:25
Definition: lws-timeout-timer.h:162