1
0
mirror of https://github.com/facebookincubator/mvfst.git synced 2025-04-18 17:24:03 +03:00
mvfst/quic/codec/DefaultConnectionIdAlgo.h
Hani Damlaj 00e67c1bf9 mvfst License Header Update
Reviewed By: lnicco

Differential Revision: D33587012

fbshipit-source-id: 972eb440f0156c9c04aa6e8787561b18295c1a97
2022-01-18 13:56:12 -08:00

79 lines
2.6 KiB
C++

/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
#pragma once
#include <folly/Expected.h>
#include <quic/QuicException.h>
#include <quic/codec/ConnectionIdAlgo.h>
#include <quic/codec/QuicConnectionId.h>
namespace quic {
/**
* Default implementation with algorithms to encode and decode for
* ConnectionId given routing info (embedded in ServerConnectionIdParams)
*
* The schema for connection id is defined as follows:
*
* First 2 (0 - 1) bits are reserved for short version id of the connection id
* If the load balancer (e.g. L4 lb) doesn't understand this version,
* it can fallback to default routing
* Depending on version following mappings:
* Version 1:
* Next 16 bits (2 - 17) are reserved for host id (L4 LB use)
* Next 8 bits (18 - 25) are reserved for worker id
* Next bit 26 is reserved for the Quic server id: server id is used to
* distinguish between the takeover instance and the taken over one
0 1 2 3 4 .. 17 18 .. 25 26 27 28 .. 63
|VERSION| For L4 LB | WORKER_ID | SERVER_ID | ..
*
* Version 2:
* Next 6 bits (2 - 7) are not used (random)
* Next 24 bits (8 - 31) are reserved for host id
* Next 8 bits (32 - 39) are reserved for worker id
* Next bit 40 is reserved for the Quic server id
0 1 2 .. 7 8 .. 31 32 .. 39 40 41 ... 63
|VERSION| UNUSED | For L4 LB | WORKER_ID | SERVER_ID | ..
*/
class DefaultConnectionIdAlgo : public ConnectionIdAlgo {
public:
~DefaultConnectionIdAlgo() override = default;
/**
* Check if this implementation of algorithm can parse the given ConnectionId
*/
bool canParse(const ConnectionId& id) const noexcept override;
/**
* Parses ServerConnectionIdParams from the given connection id.
*/
folly::Expected<ServerConnectionIdParams, QuicInternalException>
parseConnectionId(const ConnectionId& id) noexcept override;
/**
* Encodes the given ServerConnectionIdParams into connection id
*/
folly::Expected<ConnectionId, QuicInternalException> encodeConnectionId(
const ServerConnectionIdParams& params) noexcept override;
};
/**
* Factory Interface to create ConnectionIdAlgo instance.
*/
class DefaultConnectionIdAlgoFactory : public ConnectionIdAlgoFactory {
public:
~DefaultConnectionIdAlgoFactory() override = default;
std::unique_ptr<ConnectionIdAlgo> make() override {
return std::make_unique<DefaultConnectionIdAlgo>();
}
};
} // namespace quic