[−][src]Struct quiche::Config
Stores configuration shared between multiple connections.
Implementations
impl Config
[src]
pub fn new(version: u32) -> Result<Config>
[src]
Creates a config object with the given version.
Examples:
let config = quiche::Config::new(quiche::PROTOCOL_VERSION)?;
pub fn load_cert_chain_from_pem_file(&mut self, file: &str) -> Result<()>
[src]
Configures the given certificate chain.
The content of file
is parsed as a PEM-encoded leaf certificate,
followed by optional intermediate certificates.
Examples:
config.load_cert_chain_from_pem_file("/path/to/cert.pem")?;
pub fn load_priv_key_from_pem_file(&mut self, file: &str) -> Result<()>
[src]
Configures the given private key.
The content of file
is parsed as a PEM-encoded private key.
Examples:
config.load_priv_key_from_pem_file("/path/to/key.pem")?;
pub fn load_verify_locations_from_file(&mut self, file: &str) -> Result<()>
[src]
Specifies a file where trusted CA certificates are stored for the purposes of certificate verification.
The content of file
is parsed as a PEM-encoded certificate chain.
Examples:
config.load_verify_locations_from_file("/path/to/cert.pem")?;
pub fn load_verify_locations_from_directory(&mut self, dir: &str) -> Result<()>
[src]
Specifies a directory where trusted CA certificates are stored for the purposes of certificate verification.
The content of dir
a set of PEM-encoded certificate chains.
Examples:
config.load_verify_locations_from_directory("/path/to/certs")?;
pub fn verify_peer(&mut self, verify: bool)
[src]
Configures whether to verify the peer's certificate.
The default value is true
for client connections, and false
for
server ones.
pub fn grease(&mut self, grease: bool)
[src]
Configures whether to send GREASE values.
The default value is true
.
pub fn log_keys(&mut self)
[src]
Enables logging of secrets.
When logging is enabled, the set_keylog()
method must be called on
the connection for its cryptographic secrets to be logged in the
keylog format to the specified writer.
pub fn enable_early_data(&mut self)
[src]
Enables sending or receiving early data.
pub fn set_application_protos(&mut self, protos: &[u8]) -> Result<()>
[src]
Configures the list of supported application protocols.
The list of protocols protos
must be in wire-format (i.e. a series
of non-empty, 8-bit length-prefixed strings).
On the client this configures the list of protocols to send to the server as part of the ALPN extension.
On the server this configures the list of supported protocols to match against the client-supplied list.
Applications must set a value, but no default is provided.
Examples:
config.set_application_protos(b"\x08http/1.1\x08http/0.9")?;
pub fn set_max_idle_timeout(&mut self, v: u64)
[src]
Sets the max_idle_timeout
transport parameter.
The default value is infinite, that is, no timeout is used.
pub fn set_max_udp_payload_size(&mut self, v: u64)
[src]
Sets the max_udp_payload_size transport
parameter.
The default value is 65527
.
pub fn set_initial_max_data(&mut self, v: u64)
[src]
Sets the initial_max_data
transport parameter.
When set to a non-zero value quiche will only allow at most v
bytes
of incoming stream data to be buffered for the whole connection (that
is, data that is not yet read by the application) and will allow more
data to be received as the buffer is consumed by the application.
The default value is 0
.
pub fn set_initial_max_stream_data_bidi_local(&mut self, v: u64)
[src]
Sets the initial_max_stream_data_bidi_local
transport parameter.
When set to a non-zero value quiche will only allow at most v
bytes
of incoming stream data to be buffered for each locally-initiated
bidirectional stream (that is, data that is not yet read by the
application) and will allow more data to be received as the buffer is
consumed by the application.
The default value is 0
.
pub fn set_initial_max_stream_data_bidi_remote(&mut self, v: u64)
[src]
Sets the initial_max_stream_data_bidi_remote
transport parameter.
When set to a non-zero value quiche will only allow at most v
bytes
of incoming stream data to be buffered for each remotely-initiated
bidirectional stream (that is, data that is not yet read by the
application) and will allow more data to be received as the buffer is
consumed by the application.
The default value is 0
.
pub fn set_initial_max_stream_data_uni(&mut self, v: u64)
[src]
Sets the initial_max_stream_data_uni
transport parameter.
When set to a non-zero value quiche will only allow at most v
bytes
of incoming stream data to be buffered for each unidirectional stream
(that is, data that is not yet read by the application) and will allow
more data to be received as the buffer is consumed by the application.
The default value is 0
.
pub fn set_initial_max_streams_bidi(&mut self, v: u64)
[src]
Sets the initial_max_streams_bidi
transport parameter.
When set to a non-zero value quiche will only allow v
number of
concurrent remotely-initiated bidirectional streams to be open at any
given time and will increase the limit automatically as streams are
completed.
A bidirectional stream is considered completed when all incoming data
has been read by the application (up to the fin
offset) or the
stream's read direction has been shutdown, and all outgoing data has
been acked by the peer (up to the fin
offset) or the stream's write
direction has been shutdown.
The default value is 0
.
pub fn set_initial_max_streams_uni(&mut self, v: u64)
[src]
Sets the initial_max_streams_uni
transport parameter.
When set to a non-zero value quiche will only allow v
number of
concurrent remotely-initiated unidirectional streams to be open at any
given time and will increase the limit automatically as streams are
completed.
A unidirectional stream is considered completed when all incoming data
has been read by the application (up to the fin
offset) or the
stream's read direction has been shutdown.
The default value is 0
.
pub fn set_ack_delay_exponent(&mut self, v: u64)
[src]
Sets the ack_delay_exponent
transport parameter.
The default value is 3
.
pub fn set_max_ack_delay(&mut self, v: u64)
[src]
Sets the max_ack_delay
transport parameter.
The default value is 25
.
pub fn set_disable_active_migration(&mut self, v: bool)
[src]
Sets the disable_active_migration
transport parameter.
The default value is false
.
pub fn set_cc_algorithm_name(&mut self, name: &str) -> Result<()>
[src]
Sets the congestion control algorithm used by string.
The default value is reno
. On error Error::CongestionControl
will be returned.
Examples:
config.set_cc_algorithm_name("reno");
pub fn set_cc_algorithm(&mut self, algo: CongestionControlAlgorithm)
[src]
Sets the congestion control algorithm used.
The default value is CongestionControlAlgorithm::CUBIC
.
pub fn enable_hystart(&mut self, v: bool)
[src]
Configures whether to enable HyStart++.
The default value is true
.
pub fn enable_dgram(
&mut self,
enabled: bool,
recv_queue_len: usize,
send_queue_len: usize
)
[src]
&mut self,
enabled: bool,
recv_queue_len: usize,
send_queue_len: usize
)
Configures whether to enable receiving DATAGRAM frames.
When enabled, the max_datagram_frame_size
transport parameter is set
to 65536 as recommended by draft-ietf-quic-datagram-01.
The default is false
.
Auto Trait Implementations
impl RefUnwindSafe for Config
impl Send for Config
impl !Sync for Config
impl Unpin for Config
impl UnwindSafe for Config
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,