Orbit Framework 2.0.0
A high-performance asynchronous C++20 HTTP server framework.
Loading...
Searching...
No Matches
orbit::server::QuicConnection Class Reference

Represents a single QUIC connection. More...

#include <QuicConnection.hpp>

Inheritance diagram for orbit::server::QuicConnection:
Collaboration diagram for orbit::server::QuicConnection:

Public Member Functions

 QuicConnection (QuicConnectionManager &manager, const ngtcp2_cid &client_dcid, const ngtcp2_cid &client_scid, const ngtcp2_cid &server_scid, const sockaddr_in &remote_addr, SSL_CTX *ssl_ctx)
 Constructs a QuicConnection.
 
 ~QuicConnection ()
 
void process_packet (const uint8_t *data, size_t datalen, const sockaddr_in &remote_addr)
 Processes an incoming QUIC packet.
 
void handle_expiry ()
 Runs QUIC timers that are due (loss detection, delayed ACKs, idle timeout, the closing period). Event-loop thread.
 
int64_t ns_until_expiry () const
 Nanoseconds until the next timer is due (0 if overdue), or -1 if none.
 
bool is_closed () const
 True once the connection has ended and can be forgotten.
 
std::vector< ngtcp2_cid > take_issued_cids ()
 
std::vector< ngtcp2_cid > take_retired_cids ()
 
std::recursive_mutex & mutex ()
 
void extend_stream_credit (int64_t stream_id, uint64_t consumed)
 
void send_pending_data ()
 Sends any pending data for the connection.
 
QuicConnectionManager & manager ()
 
QuicHttp3Session * http3_session ()
 The HTTP/3 session, once the handshake has completed. Caller holds mutex().
 
std::string remote_ip () const
 The peer's IP address as text.
 

Private Member Functions

void start_closing (int liberr)
 
void enter_draining ()
 
void apply_error_action (quic::detail::ErrorAction action, int liberr)
 
ngtcp2_tstamp get_timestamp () const
 
bool init_ssl (SSL_CTX *ssl_ctx)
 

Static Private Member Functions

static int on_handshake_completed (ngtcp2_conn *conn, void *user_data)
 
static void rand_cb (uint8_t *dest, size_t destlen, const ngtcp2_rand_ctx *rand_ctx)
 
static int get_new_connection_id_cb (ngtcp2_conn *conn, ngtcp2_cid *cid, uint8_t *token, size_t cidlen, void *user_data)
 
static int get_path_challenge_data_cb (ngtcp2_conn *conn, uint8_t *data, void *user_data)
 
static int on_recv_stream_data (ngtcp2_conn *conn, uint32_t flags, int64_t stream_id, uint64_t offset, const uint8_t *data, size_t datalen, void *user_data, void *stream_user_data)
 
static int on_get_new_connection_id (ngtcp2_conn *conn, ngtcp2_cid *cid, uint8_t *token, size_t cidlen, void *user_data)
 
static int on_remove_connection_id (ngtcp2_conn *conn, const ngtcp2_cid *cid, void *user_data)
 
static int on_acked_stream_data_offset (ngtcp2_conn *conn, int64_t stream_id, uint64_t offset, uint64_t datalen, void *user_data, void *stream_user_data)
 
static int on_stream_close (ngtcp2_conn *conn, uint32_t flags, int64_t stream_id, uint64_t app_error_code, void *user_data, void *stream_user_data)
 
static int on_stream_reset (ngtcp2_conn *conn, int64_t stream_id, uint64_t final_size, uint64_t app_error_code, void *user_data, void *stream_user_data)
 
static int on_stream_stop_sending (ngtcp2_conn *conn, int64_t stream_id, uint64_t app_error_code, void *user_data, void *stream_user_data)
 
static int on_extend_max_stream_data (ngtcp2_conn *conn, int64_t stream_id, uint64_t max_data, void *user_data, void *stream_user_data)
 
static int on_extend_max_remote_streams_bidi (ngtcp2_conn *conn, uint64_t max_streams, void *user_data)
 

Private Attributes

QuicConnectionManager & manager_
 
sockaddr_in local_addr_
 
sockaddr_in remote_addr_
 
ngtcp2_conn * conn_ {nullptr}
 
SSL * ssl_ = nullptr
 
ngtcp2_crypto_conn_ref conn_ref_ {}
 
std::unique_ptr< QuicHttp3Session > h3_session_
 
std::recursive_mutex mutex_
 
bool closed_ = false
 
bool closing_ = false
 
std::chrono::steady_clock::time_point close_deadline_ {}
 
std::vector< ngtcp2_cid > issued_cids_
 
std::vector< ngtcp2_cid > retired_cids_
 

Detailed Description

Represents a single QUIC connection.

Constructor & Destructor Documentation

◆ QuicConnection()

orbit::server::QuicConnection::QuicConnection ( QuicConnectionManager &  manager,
const ngtcp2_cid &  client_dcid,
const ngtcp2_cid &  client_scid,
const ngtcp2_cid &  server_scid,
const sockaddr_in &  remote_addr,
SSL_CTX *  ssl_ctx 
)

Constructs a QuicConnection.

Parameters
managerThe QUIC connection manager.
client_dcidClient destination connection ID.
client_scidClient source connection ID.
server_scidServer source connection ID.
remote_addrThe remote address.
ssl_ctxThe SSL context.

◆ ~QuicConnection()

orbit::server::QuicConnection::~QuicConnection ( )

Member Function Documentation

◆ apply_error_action()

void orbit::server::QuicConnection::apply_error_action ( quic::detail::ErrorAction  action,
int  liberr 
)
private

◆ enter_draining()

void orbit::server::QuicConnection::enter_draining ( )
private

◆ extend_stream_credit()

void orbit::server::QuicConnection::extend_stream_credit ( int64_t  stream_id,
uint64_t  consumed 
)

Returns flow-control credit for consumed bytes the application has taken off stream_id. Caller holds mutex().

◆ get_new_connection_id_cb()

static int orbit::server::QuicConnection::get_new_connection_id_cb ( ngtcp2_conn *  conn,
ngtcp2_cid *  cid,
uint8_t *  token,
size_t  cidlen,
void *  user_data 
)
staticprivate

◆ get_path_challenge_data_cb()

static int orbit::server::QuicConnection::get_path_challenge_data_cb ( ngtcp2_conn *  conn,
uint8_t *  data,
void *  user_data 
)
staticprivate

◆ get_timestamp()

ngtcp2_tstamp orbit::server::QuicConnection::get_timestamp ( ) const
private

◆ handle_expiry()

void orbit::server::QuicConnection::handle_expiry ( )

Runs QUIC timers that are due (loss detection, delayed ACKs, idle timeout, the closing period). Event-loop thread.

◆ http3_session()

QuicHttp3Session * orbit::server::QuicConnection::http3_session ( )
inline

The HTTP/3 session, once the handshake has completed. Caller holds mutex().

◆ init_ssl()

bool orbit::server::QuicConnection::init_ssl ( SSL_CTX *  ssl_ctx)
private

◆ is_closed()

bool orbit::server::QuicConnection::is_closed ( ) const
inline

True once the connection has ended and can be forgotten.

◆ manager()

QuicConnectionManager & orbit::server::QuicConnection::manager ( )
inline

◆ mutex()

std::recursive_mutex & orbit::server::QuicConnection::mutex ( )
inline

Guards ngtcp2/nghttp3 state: packets are processed on the event loop, responses are submitted from worker threads.

◆ ns_until_expiry()

int64_t orbit::server::QuicConnection::ns_until_expiry ( ) const

Nanoseconds until the next timer is due (0 if overdue), or -1 if none.

◆ on_acked_stream_data_offset()

static int orbit::server::QuicConnection::on_acked_stream_data_offset ( ngtcp2_conn *  conn,
int64_t  stream_id,
uint64_t  offset,
uint64_t  datalen,
void *  user_data,
void *  stream_user_data 
)
staticprivate

◆ on_extend_max_remote_streams_bidi()

static int orbit::server::QuicConnection::on_extend_max_remote_streams_bidi ( ngtcp2_conn *  conn,
uint64_t  max_streams,
void *  user_data 
)
staticprivate

◆ on_extend_max_stream_data()

static int orbit::server::QuicConnection::on_extend_max_stream_data ( ngtcp2_conn *  conn,
int64_t  stream_id,
uint64_t  max_data,
void *  user_data,
void *  stream_user_data 
)
staticprivate

◆ on_get_new_connection_id()

static int orbit::server::QuicConnection::on_get_new_connection_id ( ngtcp2_conn *  conn,
ngtcp2_cid *  cid,
uint8_t *  token,
size_t  cidlen,
void *  user_data 
)
staticprivate

◆ on_handshake_completed()

static int orbit::server::QuicConnection::on_handshake_completed ( ngtcp2_conn *  conn,
void *  user_data 
)
staticprivate

◆ on_recv_stream_data()

static int orbit::server::QuicConnection::on_recv_stream_data ( ngtcp2_conn *  conn,
uint32_t  flags,
int64_t  stream_id,
uint64_t  offset,
const uint8_t *  data,
size_t  datalen,
void *  user_data,
void *  stream_user_data 
)
staticprivate

◆ on_remove_connection_id()

static int orbit::server::QuicConnection::on_remove_connection_id ( ngtcp2_conn *  conn,
const ngtcp2_cid *  cid,
void *  user_data 
)
staticprivate

◆ on_stream_close()

static int orbit::server::QuicConnection::on_stream_close ( ngtcp2_conn *  conn,
uint32_t  flags,
int64_t  stream_id,
uint64_t  app_error_code,
void *  user_data,
void *  stream_user_data 
)
staticprivate

◆ on_stream_reset()

static int orbit::server::QuicConnection::on_stream_reset ( ngtcp2_conn *  conn,
int64_t  stream_id,
uint64_t  final_size,
uint64_t  app_error_code,
void *  user_data,
void *  stream_user_data 
)
staticprivate

◆ on_stream_stop_sending()

static int orbit::server::QuicConnection::on_stream_stop_sending ( ngtcp2_conn *  conn,
int64_t  stream_id,
uint64_t  app_error_code,
void *  user_data,
void *  stream_user_data 
)
staticprivate

◆ process_packet()

void orbit::server::QuicConnection::process_packet ( const uint8_t *  data,
size_t  datalen,
const sockaddr_in &  remote_addr 
)

Processes an incoming QUIC packet.

Parameters
dataThe packet data.
datalenThe length of the data.
remote_addrThe remote address.

◆ rand_cb()

static void orbit::server::QuicConnection::rand_cb ( uint8_t *  dest,
size_t  destlen,
const ngtcp2_rand_ctx *  rand_ctx 
)
staticprivate

◆ remote_ip()

std::string orbit::server::QuicConnection::remote_ip ( ) const

The peer's IP address as text.

◆ send_pending_data()

void orbit::server::QuicConnection::send_pending_data ( )

Sends any pending data for the connection.

◆ start_closing()

void orbit::server::QuicConnection::start_closing ( int  liberr)
private

◆ take_issued_cids()

std::vector< ngtcp2_cid > orbit::server::QuicConnection::take_issued_cids ( )

Connection IDs this connection issued or retired since the last call; the manager routes packets for them to this connection.

◆ take_retired_cids()

std::vector< ngtcp2_cid > orbit::server::QuicConnection::take_retired_cids ( )

Member Data Documentation

◆ close_deadline_

std::chrono::steady_clock::time_point orbit::server::QuicConnection::close_deadline_ {}
private

◆ closed_

bool orbit::server::QuicConnection::closed_ = false
private

◆ closing_

bool orbit::server::QuicConnection::closing_ = false
private

◆ conn_

ngtcp2_conn* orbit::server::QuicConnection::conn_ {nullptr}
private

◆ conn_ref_

ngtcp2_crypto_conn_ref orbit::server::QuicConnection::conn_ref_ {}
private

◆ h3_session_

std::unique_ptr<QuicHttp3Session> orbit::server::QuicConnection::h3_session_
private

◆ issued_cids_

std::vector<ngtcp2_cid> orbit::server::QuicConnection::issued_cids_
private

◆ local_addr_

sockaddr_in orbit::server::QuicConnection::local_addr_
private

◆ manager_

QuicConnectionManager& orbit::server::QuicConnection::manager_
private

◆ mutex_

std::recursive_mutex orbit::server::QuicConnection::mutex_
mutableprivate

◆ remote_addr_

sockaddr_in orbit::server::QuicConnection::remote_addr_
private

◆ retired_cids_

std::vector<ngtcp2_cid> orbit::server::QuicConnection::retired_cids_
private

◆ ssl_

SSL* orbit::server::QuicConnection::ssl_ = nullptr
private

The documentation for this class was generated from the following file: