transport

package

v0.0.0-...-27c307a Latest Latest Go to latest Published: Jan 4, 2022 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/PeerXu/meepo

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func RegisterNewTransportFunc(name string, fn NewTransportFunc)
func UnsupportedTransportError(name string) error
type CreateDataChannelOption
- func WithOrdered(ordered bool) CreateDataChannelOption
type DataChannel
type DataChannelState
- func (t DataChannelState) String() string
type HandleID
type NewTransportFunc
type NewTransportOption
type OnDataChannelCreateHandler
type OnTransportStateHandler
type Transport
- func NewTransport(name string, opts ...NewTransportOption) (Transport, error)
type TransportState
- func (t TransportState) String() string

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	DataChannelNotFoundError = fmt.Errorf("DataChannel not found")
)

View Source

var (
	DataChannelStateStr = []string{
		DataChannelStateConnecting: "connecting",
		DataChannelStateOpen:       "open",
		DataChannelStateClosing:    "closing",
		DataChannelStateClosed:     "closed",
	}
)

Functions ¶

func RegisterNewTransportFunc ¶

func RegisterNewTransportFunc(name string, fn NewTransportFunc)

func UnsupportedTransportError ¶

func UnsupportedTransportError(name string) error

Types ¶

type CreateDataChannelOption ¶

type CreateDataChannelOption = ofn.OFN

func WithOrdered ¶

func WithOrdered(ordered bool) CreateDataChannelOption

type DataChannel ¶

type DataChannel interface {
	Transport() Transport
	Label() string
	State() DataChannelState
	OnOpen(func())
	io.ReadWriteCloser
}

type DataChannelState ¶

type DataChannelState int

const (
	DataChannelStateConnecting DataChannelState = iota + 1
	DataChannelStateOpen
	DataChannelStateClosing
	DataChannelStateClosed
)

func (DataChannelState) String ¶

func (t DataChannelState) String() string

type HandleID ¶

type HandleID = uint32

type NewTransportFunc ¶

type NewTransportFunc func(...NewTransportOption) (Transport, error)

type NewTransportOption ¶

type NewTransportOption = ofn.OFN

func WithID ¶

func WithID(id string) NewTransportOption

func WithLogger ¶

func WithLogger(logger logrus.FieldLogger) NewTransportOption

func WithPeerID ¶

func WithPeerID(id string) NewTransportOption

type OnDataChannelCreateHandler ¶

type OnDataChannelCreateHandler func(DataChannel)

type OnTransportStateHandler ¶

type OnTransportStateHandler func(HandleID)

type Transport ¶

type Transport interface {
	PeerID() string
	Err() error
	Close() error
	OnTransportStateChange(func(TransportState))
	OnTransportState(TransportState, func(hid HandleID)) HandleID
	UnsetOnTransportState(s TransportState, hid HandleID)
	TransportState() TransportState

	DataChannels() ([]DataChannel, error)
	DataChannel(label string) (DataChannel, error)
	CreateDataChannel(label string, opts ...CreateDataChannelOption) (DataChannel, error)
	OnDataChannelCreate(label string, f func(DataChannel))
}

func NewTransport ¶

func NewTransport(name string, opts ...NewTransportOption) (Transport, error)

type TransportState ¶

type TransportState int

const (
	TransportStateNew TransportState = iota + 1
	TransportStateConnecting
	TransportStateConnected
	TransportStateDisconnected
	TransportStateFailed
	TransportStateClosed
)

func (TransportState) String ¶

func (t TransportState) String() string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
loopback
webrtc

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL