Enum SipConnection 

pub enum SipConnection {
    Channel(ChannelConnection),
    Udp(UdpConnection),
    Tcp(TcpConnection),
    TcpListener(TcpListenerConnection),
    Tls(TlsConnection),
    TlsListener(TlsListenerConnection),
    WebSocket(WebSocketConnection),
    WebSocketListener(WebSocketListenerConnection),
}

SIP Connection

SipConnection is an enum that abstracts different transport protocols used for SIP communication. It provides a unified interface for sending SIP messages regardless of the underlying transport mechanism.

Supported Transports

• Udp - UDP transport for connectionless communication
• Channel - In-memory channel for testing and local communication
• Tcp - TCP transport for reliable connection-oriented communication
• Tls - TLS transport for secure communication over TCP
• WebSocket - WebSocket transport for web-based SIP clients

Key Features

• Transport abstraction - uniform interface across protocols
• Reliability detection - distinguishes reliable vs unreliable transports
• Address management - tracks local and remote addresses
• Message sending - handles protocol-specific message transmission
• Via header processing - automatic received parameter handling

Examples

use rsipstack::transport::{SipConnection, SipAddr};
use rsip::SipMessage;

// Send a message through any connection type
async fn send_message(
    connection: &SipConnection,
    message: SipMessage,
    destination: Option<&SipAddr>
) -> rsipstack::Result<()> {
    connection.send(message, destination).await?;
    Ok(())
}

// Check if transport is reliable
let is_reliable = connection.is_reliable();
if is_reliable {
    println!("Using reliable transport");
} else {
    println!("Using unreliable transport - retransmissions may be needed");
}

Transport Characteristics

UDP

• Connectionless and unreliable
• Requires retransmission handling
• Lower overhead
• Default SIP transport

TCP

• Connection-oriented and reliable
• No retransmission needed
• Higher overhead
• Better for large messages

TLS

• Secure TCP with encryption
• Reliable transport
• Certificate-based authentication
• Used for SIPS URIs

WebSocket

• Web-friendly transport
• Reliable connection
• Firewall and NAT friendly
• Used in web applications

Via Header Processing

SipConnection automatically handles Via header processing for incoming messages, adding ‘received’ and ‘rport’ parameters as needed per RFC 3261.

Variants

Channel(ChannelConnection)

Udp(UdpConnection)

Tcp(TcpConnection)

TcpListener(TcpListenerConnection)

Tls(TlsConnection)

TlsListener(TlsListenerConnection)

WebSocket(WebSocketConnection)

WebSocketListener(WebSocketListenerConnection)

Implementations

impl SipConnection

pub fn is_reliable(&self) -> bool

pub fn cancel_token(&self) -> Option<CancellationToken>

pub fn get_addr(&self) -> &SipAddr

pub async fn send( &self, msg: SipMessage, destination: Option<&SipAddr>, ) -> Result<()>

pub async fn serve_loop(&self, sender: TransportSender) -> Result<()>

pub async fn close(&self) -> Result<()>

impl SipConnection

pub fn update_msg_received( msg: SipMessage, addr: SocketAddr, transport: Transport, ) -> Result<SipMessage>

pub fn resolve_bind_address(addr: SocketAddr) -> SocketAddr

pub fn build_via_received( via: &mut Via, addr: SocketAddr, transport: Transport, ) -> Result<()>

pub fn parse_target_from_via(via: &Via) -> Result<(Transport, HostWithPort)>

pub fn get_destination(msg: &SipMessage) -> Result<SocketAddr>

Trait Implementations

impl Clone for SipConnection

fn clone(&self) -> SipConnection

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SipConnection

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

Formats the value using the given formatter.

impl Display for SipConnection

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

Formats the value using the given formatter.

impl From<ChannelConnection> for SipConnection

fn from(connection: ChannelConnection) -> Self

Converts to this type from the input type.

impl From<TcpConnection> for SipConnection

fn from(connection: TcpConnection) -> Self

Converts to this type from the input type.

impl From<TcpListenerConnection> for SipConnection

fn from(connection: TcpListenerConnection) -> Self

Converts to this type from the input type.

impl From<TlsConnection> for SipConnection

fn from(connection: TlsConnection) -> Self

Converts to this type from the input type.

impl From<TlsListenerConnection> for SipConnection

Available on crate feature rustls only.

fn from(connection: TlsListenerConnection) -> Self

Converts to this type from the input type.

impl From<UdpConnection> for SipConnection

fn from(connection: UdpConnection) -> Self

Converts to this type from the input type.

impl From<WebSocketConnection> for SipConnection

fn from(connection: WebSocketConnection) -> Self

Converts to this type from the input type.

impl From<WebSocketListenerConnection> for SipConnection

Available on crate feature websocket only.

fn from(connection: WebSocketListenerConnection) -> Self

Converts to this type from the input type.