network

Documentation

Index

• Constants
• type BufferTransportGenerator
• type DataChannelCreated
  • func (d *DataChannelCreated) StreamIdentifier() uint16
• type DataChannelEvent
• type DataChannelEventHandler
• type DataChannelEventType
• type DataChannelMessage
  • func (d *DataChannelMessage) StreamIdentifier() uint16
• type DataChannelOpen
  • func (d *DataChannelOpen) StreamIdentifier() uint16
• type ICENotifier
• type Manager
  • func NewManager(urls []*ice.URL, btg BufferTransportGenerator, ntf ICENotifier) *Manager
  • func (m *Manager) AcceptDataChannel() (*datachannel.DataChannel, error)
  • func (m *Manager) AddTransportPair(ssrc uint32, Rtp chan<- *rtp.Packet, Rtcp chan<- rtcp.Packet)
  • func (m *Manager) Close() error
  • func (m *Manager) CreateContextSRTP(keyingMaterial []byte, isOffer bool) error
  • func (m *Manager) OpenDataChannel(id uint16, config *datachannel.Config) (*datachannel.DataChannel, error)
  • func (m *Manager) SendRTCP(pkt []byte)
  • func (m *Manager) SendRTP(packet *rtp.Packet)
  • func (m *Manager) Start(isOffer bool, remoteUfrag, remotePwd string, dtlsCert *x509.Certificate, ...) error
• type TransportPair

Constants

const (
	NewDataChannel int = iota + 1
	NewMessage
)

Enums for DataChannelEventType

Types

type BufferTransportGenerator

type BufferTransportGenerator func(uint32, uint8) *TransportPair

BufferTransportGenerator generates a new channel for the associated SSRC This channel is used to send RTP and RTCP packets to users of pion-WebRTC

type DataChannelCreated

type DataChannelCreated struct {
	Label string
	// contains filtered or unexported fields
}

DataChannelCreated is emitted when a new DataChannel is created

func (*DataChannelCreated) StreamIdentifier

func (d *DataChannelCreated) StreamIdentifier() uint16

StreamIdentifier returns the streamIdentifier

type DataChannelEvent

type DataChannelEvent interface {
	StreamIdentifier() uint16
}

DataChannelEvent is the interface for all events that flow across the DataChannelEventHandler

type DataChannelEventHandler

type DataChannelEventHandler func(DataChannelEvent)

DataChannelEventHandler notifies the RTCPeerConnection of events relating to DataChannels

type DataChannelEventType

type DataChannelEventType int

DataChannelEventType is the enum used to represent different types of DataChannelEvent

type DataChannelMessage

type DataChannelMessage struct {
	Payload datachannel.Payload
	// contains filtered or unexported fields
}

DataChannelMessage is emitted when a DataChannel receives a message

func (*DataChannelMessage) StreamIdentifier

func (d *DataChannelMessage) StreamIdentifier() uint16

StreamIdentifier returns the streamIdentifier

type DataChannelOpen

type DataChannelOpen struct{}

DataChannelOpen is emitted when all channels should be opened

func (*DataChannelOpen) StreamIdentifier

func (d *DataChannelOpen) StreamIdentifier() uint16

StreamIdentifier returns the streamIdentifier

type ICENotifier

type ICENotifier func(ice.ConnectionState)

ICENotifier notifies the RTCPeerConnection if ICE state has changed

type Manager

type Manager struct {
	IceAgent *ice.Agent
	// contains filtered or unexported fields
}

Manager contains all network state (DTLS, SRTP) that is shared between ports It is also used to perform operations that involve multiple ports

func NewManager

func NewManager(urls []*ice.URL, btg BufferTransportGenerator, ntf ICENotifier) *Manager

NewManager creates a new network.Manager

func (*Manager) AcceptDataChannel

func (m *Manager) AcceptDataChannel() (*datachannel.DataChannel, error)

AcceptDataChannel is used to accept incoming data channels TODO: Move to RTCSctpTransport

func (*Manager) AddTransportPair

func (m *Manager) AddTransportPair(ssrc uint32, Rtp chan<- *rtp.Packet, Rtcp chan<- rtcp.Packet)

AddTransportPair notifies the network manager that an RTCTrack has been created externally, and packets may be incoming with this ssrc

func (*Manager) Close

func (m *Manager) Close() error

Close cleans up all the allocated state

func (*Manager) CreateContextSRTP

func (m *Manager) CreateContextSRTP(keyingMaterial []byte, isOffer bool) error

CreateContextSRTP takes the exported keying material from DTLS and creates Client/Server contexts

func (*Manager) OpenDataChannel

func (m *Manager) OpenDataChannel(id uint16, config *datachannel.Config) (*datachannel.DataChannel, error)

OpenDataChannel is used to open a data channel TODO: Move to RTCSctpTransport

func (*Manager) SendRTCP

func (m *Manager) SendRTCP(pkt []byte)

SendRTCP finds a connected port and sends the passed RTCP packet

func (*Manager) SendRTP

func (m *Manager) SendRTP(packet *rtp.Packet)

SendRTP finds a connected port and sends the passed RTP packet

func (*Manager) Start

func (m *Manager) Start(isOffer bool,
	remoteUfrag, remotePwd string,
	dtlsCert *x509.Certificate, dtlsPrivKey crypto.PrivateKey, fingerprint, fingerprintHash string) error

Start allocates the network stack TODO: Turn into the ORTC constructors

type TransportPair

type TransportPair struct {
	RTP  chan<- *rtp.Packet
	RTCP chan<- rtcp.Packet
}

TransportPair allows the application to be notified about both Rtp and Rtcp messages incoming from the remote host