OverSIP 技术文档

1. 安装指南

系统要求

OverSIP 支持在 Linux、BSD 和 OSX 系统上运行。

安装步骤

1. 确保您的系统已安装 Ruby 环境。
2. 克隆 OverSIP 仓库到本地：

   git clone https://github.com/versatica/OverSIP.git
   

3. 进入 OverSIP 目录：

   cd OverSIP
   

4. 使用 Ruby 的包管理器安装 OverSIP：

   gem install overSIP
   

2. 项目的使用说明

OverSIP 是一款强大的、灵活的 SIP 代理和服务器，由 RFC 7118 的作者开发。以下是 OverSIP 的主要特点：

• 完全异步事件驱动设计，永不阻塞！
• 使用 Ruby 语言编写 SIP 逻辑，自由编码所需功能！
• 核心和消息解析器使用 C 语言编写，速度快。
• 支持 SIP over UDP、TCP、TLS 和 WebSocket。
• 完全支持 IPv4、IPv6 和 DNS 解析。
• 是完美的出站边缘代理。

3. 项目API使用文档

OverSIP 提供了一个基于事件和回调的简单接口，让用户完全控制所需的应用逻辑。以下是 OverSIP API 的基本使用方法：

创建 SIP 代理

require 'overSIP'

# 创建一个 OverSIP::Proxy 实例
proxy = OverSIP::Proxy.new

配置代理

proxy.config do
  # 设置监听地址和端口
  listen '0.0.0.0:5060'
  
  # 配置其他设置
  # ...
end

处理请求

proxy.on_request do |request|
  # 处理请求逻辑
end

启动代理

proxy.start

更多 API 使用详情，请参考官方文档。

4. 项目安装方式

如前所述，OverSIP 的安装非常简单，您只需要确保系统已安装 Ruby 环境，然后使用 Ruby 的包管理器进行安装即可。

gem install overSIP