transports

Documentation

Index

• Variables
• func AddTransport(t cj.Transport) error
• func ConfigFromTransportType(transportType pb.TransportType, randomizePortDefault bool) (cj.Transport, error)
• func EnableDefaultTransports() error
• func GetTransportByID(id pb.TransportType) (cj.Transport, bool)
• func GetTransportByName(name string) (cj.Transport, bool)
• func New(name string) (cj.Transport, error)
• func NewWithParams(name string, params any) (cj.Transport, error)

Variables

var (
	// ErrAlreadyRegistered error when registering a transport that matches
	// an already registered ID or name.
	ErrAlreadyRegistered = errors.New("transport already registered")

	// ErrUnknownTransport provided id or name does npt match any enabled
	// transport.
	ErrUnknownTransport = errors.New("unknown transport")
)

Functions

func AddTransport

func AddTransport(t cj.Transport) error

AddTransport adds new transport

func ConfigFromTransportType

func ConfigFromTransportType(transportType pb.TransportType, randomizePortDefault bool) (cj.Transport, error)

func EnableDefaultTransports

func EnableDefaultTransports() error

EnableDefaultTransports initializes the library with default transports

func GetTransportByID

func GetTransportByID(id pb.TransportType) (cj.Transport, bool)

GetTransportByID returns transport by name

func GetTransportByName

func GetTransportByName(name string) (cj.Transport, bool)

GetTransportByName returns transport by name

func New

func New(name string) (cj.Transport, error)

New returns a new Transport

func NewWithParams

func NewWithParams(name string, params any) (cj.Transport, error)

NewWithParams returns a new Transport and attempts to set the parameters provided