transport

Documentation

Overview

Package transport provides access to various connected modes common in amateur radio.

The modes is made available through common interfaces and idioms from the net package.

Index

• Variables
• func DialURL(url *URL) (net.Conn, error)
• func DialURLContext(ctx context.Context, url *URL) (net.Conn, error)
• func RegisterContextDialer(scheme string, dialer ContextDialer)
• func RegisterDialer(scheme string, dialer Dialer)
• func UnregisterDialer(scheme string)
• type BusyChannelChecker
• type ContextDialer
• type Dialer
• type Flusher
• type PTTController
• type Robust
• type TxBuffer
• type URL
  • func ParseURL(rawurl string) (*URL, error)
  • func (u *URL) SetUser(call string)

Variables

var (
	ErrInvalidTarget     = errors.New("Invalid or missing target callsign")
	ErrDigisUnsupported  = errors.New("Digipeater path is not supported by this scheme")
	ErrMissingDialer     = errors.New("No dialer has been registered for this scheme")
	ErrUnsupportedScheme = errors.New("Unsupported URL scheme")
)

Functions

func DialURL

func DialURL(url *URL) (net.Conn, error)

DialURL calls the url.Scheme's Dialer.

If the URL's scheme is not registered, ErrMissingDialer is returned.

func DialURLContext

func DialURLContext(ctx context.Context, url *URL) (net.Conn, error)

DialURLContext calls the url.Scheme's ContextDialer.

If the URL's scheme is not registered, ErrMissingDialer is returned.

func RegisterContextDialer

func RegisterContextDialer(scheme string, dialer ContextDialer)

RegisterContextDialer registers a new scheme and it's ContextDialer.

The list of registered dialers is used by DialURL and DialURLContext.

func RegisterDialer

func RegisterDialer(scheme string, dialer Dialer)

RigisterDialer registers a new scheme and it's Dialer.

The list of registered dialers is used by DialURL and DialURLContext.

func UnregisterDialer

func UnregisterDialer(scheme string)

UnregisterDialer removes the given scheme's dialer from the list of dialers.

Types

type BusyChannelChecker

type BusyChannelChecker interface {
	// Returns true if the channel is not clear
	Busy() bool
}

A BusyChannelChecker is a generic busy detector for a physical transmission medium.

type ContextDialer

type ContextDialer interface {
	// DiaulURLContext dials a connection.
	//
	// If the given context is cancelled before the connection is made, the operation is aborted and an error returned.
	// Once successfully connected, any expiration of the context will not affect the connection.
	DialURLContext(ctx context.Context, url *URL) (net.Conn, error)
}

ContextDialer is implemented by transports that supports dialing with cancellation.

type Dialer

type Dialer interface {
	DialURL(url *URL) (net.Conn, error)
}

Dialer is implemented by transports that supports dialing a transport.URL.

type Flusher

type Flusher interface {
	// Flush flushes the transmit buffers of the underlying modem.
	Flush() error
}

type PTTController

type PTTController interface {
	SetPTT(on bool) error
}

type Robust

type Robust interface {
	// Enables/disables robust mode.
	SetRobust(r bool) error
}

type TxBuffer

type TxBuffer interface {
	// TransmitBufferLen returns the number of bytes in the out buffer queue.
	TxBufferLen() int
}

type URL

type URL struct {
	// TNC/modem/interface/network type.
	Scheme string

	// The host interface address.
	Host string

	// Host username (typically the local stations callsign) and password information.
	User *url.Userinfo

	// Target callsign.
	Target string

	// List of digipeaters ("path" between origin and target).
	Digis []string

	// List of query parameters.
	Params url.Values
}

URL contains all information needed to dial a remote node.

func ParseURL

func ParseURL(rawurl string) (*URL, error)

ParseURL parses a raw urlstring into an URL.

scheme://(mycall(:password)@)(host)(/digi1/...)/targetcall Examples:

• winmor:///LA1B (Addresses LA1B on WINMOR).
• ax25://mycall@myaxport/LD5SK/LA1B-10 (Addresses LA1B-10 via LD5SK using AX.25-port "myaxport" and "MYCALL" as source callsign).

The special query parameter host will override the host part of the path. (E.g. ax25:///LA1B?host=ax0 == ax25://ax0/LA1B).

func (*URL) SetUser

func (u *URL) SetUser(call string)

Set the URL.User's username (usually the source callsign).