simple-sip-rs 0.0.1

A Tiny, Easy To Use, Experimental SIP Library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

# simple-sip-rs: A Tiny, Easy To Use, Experimental SIP Library for Rust

## Disclaimer
simple-sip-rs is currently in its early stages of development and is not suitable for production use. It is designed for small, experimental projects and may have limitations or bugs.

## Purpose
simple-sip-rs aims to provide a basic framework for implementing SIP (Session Initiation Protocol) functionality in Rust projects. It's a work in progress and may have limitations or bugs.

Note: simple-sip-rs is designed to be opinionated, making it easier for developers to get started with SIP in Rust. However, this also means that it may not be as flexible as other libraries.

## Features
- **Basic SIP message parsing and sending**: Can handle simple SIP messages like INVITE, ACK, and BYE.
- **Support for PCMU and Opus codecs**: simple-sip-rs can handle both PCMU and opus codecs for audio communication.
- **Support for Telephone events**: simple-sip-rs can receive telephone events aka DTMF button presses (not send them currently).

## Usage

See the examples folder for a more complete example.

```rust
use std::net::SocketAddr;
use std::str::FromStr;
use simple_sip_rs::config::Config;
use simple_sip_rs::manager::SipManager;

async fn connect_and_call() {
    let config = Config {
        server_addr: SocketAddr::from_str("192.168.1.100").unwrap(),
        own_addr: SocketAddr::from_str("192.168.1.2").unwrap(),
        username: "username".to_string(),
        password: "password".to_string(),
    };
    
    
    let mut sip_manager = SipManager::from_config(config).await.unwrap();
    sip_manager.start().await.unwrap();
    
    let outgoing_call = sip_manager.call("1000".to_string());
}
```

## Limitations and Future Plans

- Limited functionality: simple-sip-rs currently supports only a subset of SIP features. More features might be implemented over time. (PRs welcome)
- Experimental status: The API may change as the library evolves. Use with caution.
- Encryption: Encryption may be added in the future, but it's not guaranteed. (PRs welcome)

## Contributing
Contributions are welcome! Please feel free to open issues or submit pull requests.