1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
macro_rules! impl_handle_api {
(| $handle:ident, $dispatch:ident | $dispatch_body:expr) => {
/// Opens a new [`LocalStream`](`crate::stream::LocalStream`) with a specific type
///
/// The method will return
/// - `Ok(stream)` if a stream of the requested type was opened
/// - `Err(stream_error)` if the stream could not be opened due to an error
///
/// # Examples
///
/// ```rust,no_run
/// # async fn test() -> s2n_quic::connection::Result<()> {
/// # use s2n_quic::stream;
/// # let mut handle: s2n_quic::connection::Handle = todo!();
/// #
/// while let Ok(stream) = handle.open_stream(stream::Type::Bidirectional).await {
/// println!("Stream opened from {:?}", stream.connection().remote_addr());
/// }
/// #
/// # Ok(())
/// # }
/// ```
#[inline]
pub async fn open_stream(
&mut self,
stream_type: $crate::stream::Type,
) -> $crate::connection::Result<$crate::stream::LocalStream> {
futures::future::poll_fn(|cx| self.poll_open_stream(stream_type, cx)).await
}
/// Polls opening a [`LocalStream`](`crate::stream::LocalStream`) with a specific type
///
/// The method will return
/// - `Poll::Ready(Ok(stream))` if a stream of the requested type was opened
/// - `Poll::Ready(Err(stream_error))` if the stream could not be opened due to an error
/// - `Poll::Pending` if the stream has not been opened yet
#[inline]
pub fn poll_open_stream(
&mut self,
stream_type: $crate::stream::Type,
cx: &mut core::task::Context,
) -> core::task::Poll<$crate::connection::Result<$crate::stream::LocalStream>> {
use s2n_quic_core::stream::StreamType;
use $crate::stream::{BidirectionalStream, SendStream};
Ok(
match core::task::ready!(self.0.poll_open_stream(stream_type, cx))? {
stream if stream_type == StreamType::Unidirectional => {
SendStream::new(stream.into()).into()
}
stream => BidirectionalStream::new(stream).into(),
},
)
.into()
}
/// Opens a new [`BidirectionalStream`](`crate::stream::BidirectionalStream`)
///
/// The method will return
/// - `Ok(stream)` if a bidirectional stream was opened
/// - `Err(stream_error)` if the stream could not be opened due to an error
///
/// # Examples
///
/// ```rust,no_run
/// # async fn test() -> s2n_quic::connection::Result<()> {
/// # let mut handle: s2n_quic::connection::Handle = todo!();
/// #
/// while let Ok(mut stream) = handle.open_bidirectional_stream().await {
/// println!("Stream opened from {:?}", stream.connection().remote_addr());
/// }
/// #
/// # Ok(())
/// # }
/// ```
#[inline]
pub async fn open_bidirectional_stream(
&mut self,
) -> $crate::connection::Result<$crate::stream::BidirectionalStream> {
futures::future::poll_fn(|cx| self.poll_open_bidirectional_stream(cx)).await
}
/// Polls opening a [`BidirectionalStream`](`crate::stream::BidirectionalStream`)
///
/// The method will return
/// - `Poll::Ready(Ok(stream))` if a bidirectional stream was opened
/// - `Poll::Ready(Err(stream_error))` if the stream could not be opened due to an error
/// - `Poll::Pending` if the stream has not been opened yet
#[inline]
pub fn poll_open_bidirectional_stream(
&mut self,
cx: &mut core::task::Context,
) -> core::task::Poll<$crate::connection::Result<$crate::stream::BidirectionalStream>> {
use s2n_quic_core::stream::StreamType;
use $crate::stream::BidirectionalStream;
let stream =
core::task::ready!(self.0.poll_open_stream(StreamType::Bidirectional, cx))?;
Ok(BidirectionalStream::new(stream)).into()
}
/// Opens a [`SendStream`](`crate::stream::SendStream`)
///
/// # Examples
///
/// ```rust,no_run
/// # async fn test() -> s2n_quic::connection::Result<()> {
/// # let mut connection: s2n_quic::connection::Handle = todo!();
/// #
/// let stream = connection.open_send_stream().await?;
/// println!("Send stream opened with id: {}", stream.id());
/// #
/// # Ok(())
/// # }
/// ```
#[inline]
pub async fn open_send_stream(
&mut self,
) -> $crate::connection::Result<$crate::stream::SendStream> {
futures::future::poll_fn(|cx| self.poll_open_send_stream(cx)).await
}
/// Polls opening a [`SendStream`](`crate::stream::SendStream`)
#[inline]
pub fn poll_open_send_stream(
&mut self,
cx: &mut core::task::Context,
) -> core::task::Poll<$crate::connection::Result<$crate::stream::SendStream>> {
use s2n_quic_core::stream::StreamType;
use $crate::stream::SendStream;
let stream =
core::task::ready!(self.0.poll_open_stream(StreamType::Unidirectional, cx))?;
Ok(SendStream::new(stream.into())).into()
}
/// Returns the local address that this connection is bound to.
#[inline]
pub fn local_addr(&self) -> $crate::connection::Result<std::net::SocketAddr> {
self.0.local_address().map(std::net::SocketAddr::from)
}
/// Returns the remote address that this connection is connected to.
#[inline]
pub fn remote_addr(&self) -> $crate::connection::Result<std::net::SocketAddr> {
self.0.remote_address().map(std::net::SocketAddr::from)
}
/// Returns the negotiated server name the connection is using.
#[inline]
pub fn server_name(&self) -> $crate::connection::Result<Option<$crate::server::Name>> {
self.0.server_name()
}
/// Returns the negotiated application protocol the connection is using
#[inline]
pub fn application_protocol(&self) -> $crate::connection::Result<::bytes::Bytes> {
self.0.application_protocol()
}
/// Returns the internal identifier for the [`Connection`](`crate::Connection`)
///
/// Note: This internal identifier is not the same as the connection ID included in packet
/// headers as described in [QUIC Transport RFC](https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-id)
#[inline]
pub fn id(&self) -> u64 {
self.0.id()
}
/// Sends a Ping frame to the peer
#[inline]
pub fn ping(&mut self) -> $crate::connection::Result<()> {
self.0.ping()
}
/// Enables or disables the connection to actively keep the connection alive with the peer
///
/// This can be useful for maintaining connections beyond the configured idle timeout. The
/// connection will continue to be held open until the keep alive is disabled or the
/// connection is no longer able to be maintained due to connectivity.
#[inline]
pub fn keep_alive(&mut self, enabled: bool) -> $crate::connection::Result<()> {
self.0.keep_alive(enabled)
}
/// Closes the Connection with the provided error code
///
/// This will immediately terminate all outstanding streams.
///
/// # Examples
///
/// ```rust,no_run
/// # async fn test() -> s2n_quic::connection::Result<()> {
/// # let mut connection: s2n_quic::connection::Handle = todo!();
/// #
/// const MY_ERROR_CODE:u32 = 99;
/// connection.close(MY_ERROR_CODE.into());
/// #
/// # Ok(())
/// # }
/// ```
#[inline]
pub fn close(&self, error_code: $crate::application::Error) {
self.0.close(error_code)
}
/// API for querying the connection's
/// [`Subscriber::ConnectionContext`](crate::provider::event::Subscriber::ConnectionContext).
///
/// The ConnectionContext provides a mechanism for users to provide a custom
/// type and update it on each event. The query APIs (check
/// [`Self::query_event_context_mut`] for mutable version) provide a way to inspect the
/// ConnectionContext outside of events.
///
/// This function takes a `FnOnce(&EventContext) -> Outcome`, where `EventContext`
/// represents the type of `ConnectionContext`. If the `EventContext` type matches
/// any of the types of the configured Subscriber's context, the query is executed
/// and `Ok(Outcome)` is returned, else
/// `Err(`[`query::Error`](s2n_quic_core::query::Error)`)`.
///
/// Given that it is possible to compose Subscriber, which can have different
/// ConnectionContext types, this function traverses all Subscribers, executes
/// and short-circuiting on the first match.
///
/// # Examples
///
/// ```no_run
/// use s2n_quic::{provider::event::{events, query, Subscriber}, Connection, Server};
///
/// struct MySubscriber{}
///
/// impl Subscriber for MySubscriber {
/// type ConnectionContext = MyEventContext;
/// fn create_connection_context(
/// &mut self, _meta: &events::ConnectionMeta,
/// _info: &events::ConnectionInfo,
/// ) -> Self::ConnectionContext {
/// MyEventContext { request: 0 }
/// }
/// }
///
/// #[derive(Clone, Copy)]
/// pub struct MyEventContext {
/// request: u64,
/// }
///
/// let mut server = Server::builder()
/// .with_event(MySubscriber {}).unwrap()
/// .start().unwrap();
/// # let connection: Connection = todo!();
///
/// let outcome: Result<MyEventContext, query::Error> = connection
/// .query_event_context(|event_context: &MyEventContext| *event_context);
///
/// match outcome {
/// Ok(event_context) => {
/// // `MyEventContext` matched a Subscriber::ConnectionContext and the
/// // query executed.
/// //
/// // use the value event_context for logging, etc..
/// }
/// Err(query::Error::ConnectionLockPoisoned) => {
/// // The query did not execute because of a connection error.
/// //
/// // log an error, panic, etc..
/// }
/// Err(query::Error::ContextTypeMismatch) => {
/// // `MyEventContext` failed to match any Subscriber::ConnectionContext
/// // and the query did not execute.
/// //
/// // log an error, panic, etc..
/// }
/// Err(_) => {
/// // We encountered an unknown error so handle it generically, e.g. log,
/// // panic, etc.
/// }
/// }
/// ```
///
/// # Traverse order
/// Let's demonstrate the traversal order for matching on ConnectionContext in the
/// example below. We provide a composed Subscriber type (Foo, Bar), where both
/// Foo and Bar have a ConnectionContext type of `u64`. The query traverse order
/// is as follows:
/// - `(Foo::ConnectionContext, Bar::ConnectionContext)`
/// - `Foo::ConnectionContext`
/// - `Bar::ConnectionContext`
///
/// Note: In this example the type `u64` will always match `Foo::u64` and
/// `Bar::u64` will never be matched. If this is undesirable, applications should
/// make unique associated `ConnectionContext`s by creating new types.
///
/// ```no_run
/// use s2n_quic::{provider::event::{events, Subscriber}, Connection, Server};
///
/// struct Foo {}
///
/// impl Subscriber for Foo {
/// type ConnectionContext = u64;
/// fn create_connection_context(
/// &mut self, _meta: &events::ConnectionMeta,
/// _info: &events::ConnectionInfo,
/// ) -> Self::ConnectionContext { 0 }
/// }
///
/// struct Bar {}
///
/// impl Subscriber for Bar {
/// type ConnectionContext = u64;
/// fn create_connection_context(
/// &mut self, _meta: &events::ConnectionMeta,
/// _info: &events::ConnectionInfo,
/// ) -> Self::ConnectionContext { 0 }
/// }
///
/// let mut server = Server::builder()
/// .with_event((Foo {}, Bar {})).unwrap()
/// .start().unwrap();
/// # let connection: Connection = todo!();
///
/// // Matches Foo.
/// //
/// // Note: Because the `ConnectionContext` type is the same for
/// // both `Foo` and `Bar`, only `Foo`'s context will be matched.
/// let _ = connection.query_event_context(|ctx: &u64| *ctx );
///
/// // Matches (Foo, Bar).
/// let _ = connection.query_event_context(|ctx: &(u64, u64)| ctx.0 );
/// ```
pub fn query_event_context<Query, EventContext, Outcome>(
&self,
query: Query,
) -> core::result::Result<Outcome, s2n_quic_core::query::Error>
where
Query: FnOnce(&EventContext) -> Outcome,
EventContext: 'static,
{
use s2n_quic_core::query;
let mut query = query::Once::new(query);
self.0
.query_event_context(&mut query)
.map_err(|_| query::Error::ConnectionLockPoisoned)?;
query.into()
}
/// API for querying the connection's
/// [`Subscriber::ConnectionContext`](crate::provider::event::Subscriber::ConnectionContext).
///
/// Similar to [`Self::query_event_context`] but provides
/// mutable access to `ConnectionContext`.
///
/// ```ignore
/// let outcome = connection
/// .query_event_context(
/// |event_context: &MyEventContext| event_context.request += 1
/// );
/// ```
pub fn query_event_context_mut<Query, EventContext, Outcome>(
&mut self,
query: Query,
) -> core::result::Result<Outcome, s2n_quic_core::query::Error>
where
Query: FnOnce(&mut EventContext) -> Outcome,
EventContext: 'static,
{
use s2n_quic_core::query;
let mut query = query::Once::new_mut(query);
self.0
.query_event_context_mut(&mut query)
.map_err(|_| query::Error::ConnectionLockPoisoned)?;
query.into()
}
/// API for querying the connection's datagram endpoint.
///
/// Provides mutable access to `Sender` or `Receiver`.
///
/// ```ignore
/// let outcome = connection
/// .datagram_mut(
/// |sender: &MySender| sender.send_datagram(Bytes::from_static(&[1, 2, 3]));
/// );
/// ```
pub fn datagram_mut<Query, ProviderType, Outcome>(
&self,
query: Query,
) -> core::result::Result<Outcome, s2n_quic_core::query::Error>
where
Query: FnOnce(&mut ProviderType) -> Outcome,
ProviderType: 'static,
{
use s2n_quic_core::query;
let mut query = query::Once::new_mut(query);
self.0
.datagram_mut(&mut query)
.map_err(|_| query::Error::ConnectionLockPoisoned)?;
query.into()
}
};
}
#[derive(Clone, Debug)]
pub struct Handle(pub(crate) s2n_quic_transport::connection::Connection);
impl Handle {
impl_handle_api!(|handle, call| call!(handle));
}