Skip to main content

ServerBuilder

Struct ServerBuilder 

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

简单模式服务端构建器

提供最小实现,使用闭包定义消息处理逻辑,适合快速原型开发和学习。

§设计原则

  • 公共逻辑统一处理:基于 HybridServer,共享所有核心能力(多协议、序列化协商、心跳等)
  • 最小抽象:消息处理通过闭包定义,不依赖 trait 实现
  • 零配置:使用默认配置即可运行

§使用方式

使用闭包定义消息处理和连接事件处理逻辑,无需实现 trait。

Implementations§

Source§

impl ServerBuilder

Source

pub fn new(bind_address: impl Into<String>) -> Self

创建新的服务端构建器

§参数
  • bind_address: 监听地址,例如 “0.0.0.0:8080”
Source

pub fn with_authenticator(self, authenticator: Arc<dyn Authenticator>) -> Self

设置认证器(如果启用认证,必须提供)

如果设置了认证器,还需要在配置中启用认证:

.enable_auth()
.with_authenticator(authenticator)
Source

pub fn enable_auth(self) -> Self

启用认证

Source

pub fn with_auth_timeout(self, timeout: Duration) -> Self

设置认证超时时间

Source

pub fn on_message<F>(self, handler: F) -> Self
where F: for<'a> Fn(&'a Frame, &'a MessageContext) -> Pin<Box<dyn Future<Output = Result<Option<Frame>>> + Send + 'a>> + Send + Sync + 'static,

设置消息处理函数

§参数
  • handler: 消息处理函数,接收 FrameMessageContext,返回 Option<Frame>(可选回复)
Source

pub fn on_connect<F>(self, handler: F) -> Self
where F: for<'a> Fn(&'a str, &'a MessageContext) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'a>> + Send + Sync + 'static,

设置连接建立事件处理函数

§参数
  • handler: 连接建立处理函数,接收 connection_id 和 MessageContext
Source

pub fn on_disconnect<F>(self, handler: F) -> Self
where F: for<'a> Fn(&'a str, &'a MessageContext) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'a>> + Send + Sync + 'static,

设置连接断开事件处理函数

§参数
  • handler: 连接断开处理函数,接收 connection_id 和 MessageContext
Source

pub fn with_protocol(self, protocol: TransportProtocol) -> Self

设置传输协议

Source

pub fn with_protocols(self, protocols: Vec<TransportProtocol>) -> Self

启用多协议监听

Source

pub fn with_max_connections(self, max: usize) -> Self

设置最大连接数

Source

pub fn with_handshake_timeout(self, timeout: Duration) -> Self

设置握手超时时间

Source

pub fn with_max_handshake_concurrency(self, max: usize) -> Self

设置最大并发握手数

Source

pub fn with_write_timeout(self, timeout: Duration) -> Self

设置单次连接写入超时时间

Source

pub fn with_fanout_concurrency(self, max: usize) -> Self

设置 fanout 发送最大并发度

Source

pub fn with_heartbeat(self, heartbeat: HeartbeatConfig) -> Self

设置心跳配置

Source

pub fn with_tls(self, tls: TlsConfig) -> Self

设置 TLS 配置

Source

pub fn with_default_format(self, format: SerializationFormat) -> Self

设置默认序列化格式(用于协商,默认 Protobuf)

Source

pub fn with_default_compression(self, compression: CompressionAlgorithm) -> Self

设置默认压缩算法(用于协商,默认 None)

Source

pub fn build(self) -> Result<SimpleServer>

构建服务端

§返回

返回配置好的 SimpleServer 实例

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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> 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