Struct Endpoint 

pub struct Endpoint {
    pub inner: EndpointInnerRef,
}

SIP Endpoint

Endpoint is the main entry point for SIP protocol operations. It provides a high-level interface for creating and managing SIP transactions, handling incoming requests, and coordinating with the transport layer.

Key Features

• Transaction management and lifecycle
• Automatic timer handling per RFC 3261
• Transport layer abstraction
• Graceful shutdown support
• Incoming request processing

Examples

use rsipstack::EndpointBuilder;
use tokio_util::sync::CancellationToken;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let endpoint = EndpointBuilder::new()
        .with_user_agent("MyApp/1.0")
        .build();
     
    // Get incoming transactions
    let mut incoming = endpoint.incoming_transactions().expect("incoming_transactions");
     
    // Start the endpoint
    let endpoint_inner = endpoint.inner.clone();
    tokio::spawn(async move {
         endpoint_inner.serve().await.ok();
    });
     
    // Process incoming transactions
    while let Some(transaction) = incoming.recv().await {
        // Handle transaction
        break; // Exit for example
    }
     
    Ok(())
}

Lifecycle

1. Create endpoint using EndpointBuilder
2. Start serving with serve() method
3. Process incoming transactions via incoming_transactions()
4. Shutdown gracefully with shutdown()

Fields

inner: EndpointInnerRef

Implementations

impl Endpoint

pub async fn serve(&self)

pub fn shutdown(&self)

pub fn incoming_transactions(&self) -> Result<TransactionReceiver>

pub fn get_addrs(&self) -> Vec<SipAddr>