lws-txpacer.h

Go to the documentation of this file.

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010 - 2026 Andy Green <andy@warmcat.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */
 
#ifndef _LWS_TXPACER_H
#define _LWS_TXPACER_H
 
#if defined(LWS_HAVE_PTHREAD_H)
 
struct lws_txp;
 
typedef struct lws_txp_info {
        void            *user;
        int             (*tx_cb)(void *user, const uint8_t *buf, size_t len);
 
        uint32_t        target_rate_bps;    /* Target bits per second */
        uint32_t        interval_us;        /* Pacing interval (e.g., 2000 for 2ms) */
        size_t          max_buflist_bytes;  /* Max buffering before packet drop */
 
} lws_txp_info_t;

LWS_VISIBLE LWS_EXTERN struct lws_txp *
lws_txp_create(const lws_txp_info_t *txp_info);

LWS_VISIBLE LWS_EXTERN void
lws_txp_destroy(struct lws_txp **ptxp);

LWS_VISIBLE LWS_EXTERN int
lws_txp_append(struct lws_txp *txp, uint8_t *buf, size_t len);
 
#endif /* LWS_HAVE_PTHREAD_H */
 
#endif /* _LWS_TXPACER_H */