Documentation
¶
Index ¶
- Constants
- func IsWebRTCDirectMultiaddr(addr ma.Multiaddr) (bool, int)
- type ListenUDPFn
- type Option
- type WebRTCTransport
- func (t *WebRTCTransport) AddCertHashes(addr ma.Multiaddr) (ma.Multiaddr, bool)
- func (t *WebRTCTransport) CanDial(addr ma.Multiaddr) bool
- func (t *WebRTCTransport) Dial(ctx context.Context, remoteMultiaddr ma.Multiaddr, p peer.ID) (tpt.CapableConn, error)
- func (t *WebRTCTransport) Listen(addr ma.Multiaddr) (tpt.Listener, error)
- func (t *WebRTCTransport) ListenOrder() int
- func (t *WebRTCTransport) Protocols() []int
- func (t *WebRTCTransport) Proxy() bool
Constants ¶
View Source
const ( // DefaultDisconnectedTimeout 默认断开连接超时时间 DefaultDisconnectedTimeout = 20 * time.Second // DefaultFailedTimeout 默认失败超时时间 DefaultFailedTimeout = 30 * time.Second // DefaultKeepaliveTimeout 默认保活超时时间 DefaultKeepaliveTimeout = 15 * time.Second )
PeerConnection 的超时值 https://github.com/pion/webrtc/blob/v3.1.50/settingengine.go#L102-L109
View Source
const ( // DefaultMaxInFlightConnections 默认最大并发连接数为128 // 这个值比其他传输协议(64)要高,因为在发送初始连接请求消息(STUN Binding request)后 // 无法检测到对端是否已经离开。这些对端会占用一个goroutine直到连接超时。 // 由于并行握手的数量仍然受资源管理器的限制,这个较高的数字是可以接受的。 DefaultMaxInFlightConnections = 128 )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ListenUDPFn ¶
ListenUDPFn UDP 监听函数类型
type WebRTCTransport ¶
type WebRTCTransport struct {
// contains filtered or unexported fields
}
WebRTCTransport WebRTC 传输层实现
func New ¶
func New(privKey ic.PrivKey, psk pnet.PSK, gater connmgr.ConnectionGater, rcmgr network.ResourceManager, listenUDP ListenUDPFn, opts ...Option) (*WebRTCTransport, error)
New 创建新的 WebRTC 传输层实例 参数:
- privKey: 私钥
- psk: 预共享密钥
- gater: 连接过滤器
- rcmgr: 资源管理器
- listenUDP: UDP 监听函数
- opts: 配置选项
返回值:
- *WebRTCTransport: WebRTC 传输层实例
- error: 错误信息
func (*WebRTCTransport) AddCertHashes ¶
AddCertHashes 向多地址添加证书哈希 参数:
- addr: 多地址
返回值:
- ma.Multiaddr: 添加了证书哈希的多地址
- bool: 是否成功
func (*WebRTCTransport) CanDial ¶
func (t *WebRTCTransport) CanDial(addr ma.Multiaddr) bool
CanDial 检查是否可以拨号到指定地址 参数:
- addr: 多地址
返回值:
- bool: 是否可以拨号
func (*WebRTCTransport) Dial ¶
func (t *WebRTCTransport) Dial(ctx context.Context, remoteMultiaddr ma.Multiaddr, p peer.ID) (tpt.CapableConn, error)
Dial 拨号到远程节点 参数:
- ctx: 上下文
- remoteMultiaddr: 远程多地址
- p: 远程节点 ID
返回值:
- tpt.CapableConn: 连接
- error: 错误信息
func (*WebRTCTransport) Listen ¶
Listen 监听指定地址 参数:
- addr: 多地址
返回值:
- tpt.Listener: 监听器
- error: 错误信息
注意:
- addr 的 IP、端口组合必须是独占的,因为 WebRTC 监听器不能与其他基于 UDP 的传输层(如 QUIC 和 WebTransport)复用相同端口
- 详见 https://github.com/dep2p/issues/2446
func (*WebRTCTransport) ListenOrder ¶
func (t *WebRTCTransport) ListenOrder() int
ListenOrder 返回监听优先级 返回值:
- int: 监听优先级,比 QUIC 晚 1 以便可能复用相同端口
func (*WebRTCTransport) Protocols ¶
func (t *WebRTCTransport) Protocols() []int
Protocols 返回支持的协议列表 返回值:
- []int: 支持的协议代码列表
func (*WebRTCTransport) Proxy ¶
func (t *WebRTCTransport) Proxy() bool
Proxy 返回是否支持代理 返回值:
- bool: 是否支持代理
Source Files
¶
Click to show internal directories.
Click to hide internal directories.