Skip to main content

ClientSession

Struct ClientSession 

Source
pub struct ClientSession { /* private fields */ }
Expand description

Represents an active client session

Implementations§

Source§

impl ClientSession

Source

pub fn new( client_addr: ClientAddress, buffer_pool: BufferPool, auth_handler: Arc<AuthHandler>, metrics: MetricsCollector, ) -> Self

Create a new client session for 1:1 backend mapping

Source

pub fn new_with_router( client_addr: ClientAddress, buffer_pool: BufferPool, router: Arc<BackendSelector>, routing_mode: RoutingMode, auth_handler: Arc<AuthHandler>, metrics: MetricsCollector, ) -> Self

Create a new client session with per-command routing

Each command will be routed to a potentially different backend server using round-robin load balancing.

Source

pub fn builder( client_addr: ClientAddress, buffer_pool: BufferPool, auth_handler: Arc<AuthHandler>, metrics: MetricsCollector, ) -> ClientSessionBuilder

Create a builder for constructing a client session

§Examples
use std::net::SocketAddr;
use std::sync::Arc;
use nntp_proxy::session::ClientSession;
use nntp_proxy::pool::BufferPool;
use nntp_proxy::types::BufferSize;
use nntp_proxy::auth::AuthHandler;
use nntp_proxy::metrics::MetricsCollector;

let addr: SocketAddr = "127.0.0.1:8080".parse().unwrap();
let buffer_pool = BufferPool::new(BufferSize::try_new(8192).unwrap(), 10);
let auth_handler = Arc::new(AuthHandler::new(None, None).unwrap());
let metrics = MetricsCollector::new(1);

let session = ClientSession::builder(addr.into(), buffer_pool, auth_handler, metrics)
    .build();
Source

pub const fn client_id(&self) -> ClientId

Get the unique client ID

Source

pub const fn is_per_command_routing(&self) -> bool

Check if this session is using per-command routing

Returns true if this session has a router available (regardless of current mode). This is slightly different from checking routing mode - a session can have a router but be in Stateful mode (e.g., after hybrid mode switches).

Source

pub fn mode(&self) -> SessionMode

Get the current session mode

Source

pub fn username(&self) -> Option<&str>

Get the authenticated username (if any) - zero-cost reference

Returns the authenticated username as an Arc<str> for cheap cloning. Returns None if the client has not authenticated yet.

Source§

impl ClientSession

Source

pub async fn handle_per_command_routing( &self, client_stream: TcpStream, ) -> Result<TransferMetrics, SessionError>

Handle a client connection with per-command routing.

Each command is routed independently to potentially different backends.

§Errors

Returns an error if the router is unavailable, a client write fails, or switching into stateful mode fails.

Source§

impl ClientSession

Source

pub async fn handle_stateful_session( &self, client_stream: TcpStream, backend_id: BackendId, provider: &DeadpoolConnectionProvider, server_name: &str, ) -> Result<TransferMetrics, SessionError>

Handle stateful session - acquire backend and proxy bidirectionally

§Errors

Returns an error if the proxy cannot acquire a backend connection, send an initial backend-unavailable response, or proxy bytes in either direction.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scope for T

Source§

fn with<F, R>(self, f: F) -> R
where Self: Sized, F: FnOnce(Self) -> R,

Scoped with ownership.
Source§

fn with_ref<F, R>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Scoped with reference.
Source§

fn with_mut<F, R>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Scoped with mutable reference.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> Value for T
where T: Send + Sync + 'static,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more