Struct ConnectionBuilder

pub struct ConnectionBuilder { /* private fields */ }

Builder for creating a new SMPP connection.

Implementations

impl ConnectionBuilder

pub fn new() -> Self

Creates a new ConnectionBuilder.

pub async fn connect( self, host: impl ToSocketAddrs, ) -> Result<(Client, impl Stream<Item = Event> + Unpin + Debug + 'static), Error>

Connects to the SMPP server and performs the bind operation.

Opens and manages a connection in the background and returns a client and an event stream.

• The client is used as a handle to communicate with the server through the managed connection.
• The event stream is used to receive events from the server, such as incoming messages or errors.

pub async fn connected<S>( self, stream: S, ) -> Result<(Client, impl Stream<Item = Event> + Unpin + Debug + 'static), Error>

where S: AsyncRead + AsyncWrite + Send + Unpin + 'static,

Performs the bind operation on an already connected stream.

Manages a connection in the background and returns a client and an event stream.

• The client is used as a handle to communicate with the server through the managed connection.
• The event stream is used to receive events from the server, such as incoming messages or errors.

impl ConnectionBuilder

pub const fn max_command_length(self, max_command_length: usize) -> Self

Sets the maximum command length for incoming commands.

pub const fn bind_mode(self, bind_mode: BindMode) -> Self

Sets the bind mode for the connection.

pub const fn transmitter(self) -> Self

Sets the bind mode to transmitter.

pub const fn receiver(self) -> Self

Sets the bind mode to receiver.

pub const fn transceiver(self) -> Self

Sets the bind mode to transceiver (both transmitter and receiver).

pub fn system_id(self, system_id: COctetString<1, 16>) -> Self

Sets the system ID.

pub fn password(self, password: COctetString<1, 9>) -> Self

Sets the password.

pub fn system_type(self, system_type: COctetString<1, 13>) -> Self

Sets the system type.

pub fn addr_ton(self, addr_ton: Ton) -> Self

Sets the address TON (Type of Number).

pub fn addr_npi(self, addr_npi: Npi) -> Self

Sets the address NPI (Numbering Plan Indicator).

pub fn address_range(self, address_range: COctetString<1, 41>) -> Self

Sets the address range.

pub fn enquire_link_interval(self, enquire_link_interval: Duration) -> Self

Sets the enquire link interval.

Used to determine how often an enquire link command should be sent to the server.

pub fn response_timeout(self, response_timeout: Duration) -> Self

Sets the response timeout.

This timeout is used to determine how long the client should wait for a response from the server.

Trait Implementations

impl Debug for ConnectionBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ConnectionBuilder

fn default() -> Self

Returns the “default value” for a type.