client

package
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 4, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides a basic struct of Client object

func NewClient 

func NewClient(
	callsign string, passcode string,
	mode Mode, protocol Protocol,
	host string, port int,
	options ...Option,
) *Client

NewClient creates a new APRS client

func (*Client) Callsign 

func (c *Client) Callsign() string

func (*Client) Close 

func (c *Client) Close()

Close a client

func (*Client) Connect 

func (c *Client) Connect() error

Connect to an APRS server.

For TCP the client opens a persistent stream, performs the login handshake and starts the receive/heartbeat goroutines. For UDP it opens a connected datagram socket used in "UDP submit" mode: there is no login handshake or receive loop; instead every SendPacket datagram is prefixed with the login line (see SendPacket).

func (*Client) Filter 

func (c *Client) Filter() string

func (*Client) GetStats 

func (c *Client) GetStats() Stats

GetStats returns the current statistics

func (*Client) Host 

func (c *Client) Host() string

func (*Client) Mode 

func (c *Client) Mode() Mode

func (*Client) Port 

func (c *Client) Port() int

func (*Client) Protocol 

func (c *Client) Protocol() Protocol

func (*Client) RemoteAddr added in v1.3.0 

func (c *Client) RemoteAddr() string

RemoteAddr returns the resolved remote address of the active connection (e.g. "44.135.0.1:10152"), or "" if not connected. Unlike Host(), which is the configured (possibly DNS) hostname, this reflects the actual IP a rotating DNS name resolved to for the current session.

func (*Client) ResetStats 

func (c *Client) ResetStats()

ResetStats resets all statistics to zero

func (*Client) SendPacket 

func (c *Client) SendPacket(packet string) error

SendPacket sends an APRS packet.

For TCP the packet is written to the stream terminated by CRLF. For UDP (submit mode) the datagram is the login line followed by the packet, both CRLF-terminated, so the server can authenticate and inject each datagram independently (qAU).

func (*Client) Server 

func (c *Client) Server() string

func (*Client) ServerID added in v1.3.0 

func (c *Client) ServerID() string

ServerID returns the upstream server's callsign, parsed from its logresp line (empty until login completes).

func (*Client) Up 

func (c *Client) Up() bool

func (*Client) Uptime 

func (c *Client) Uptime() time.Time

func (*Client) Wait 

func (c *Client) Wait()

Wait the client exit

type Mode 

type Mode string

Mode is a ENUM type for client mode 

const (
	Fullfeed Mode = "fullfeed"
	IGate    Mode = "igate"
)

type Option 

type Option func(*Client)

Option provides a basic option type

func WithBufSize added in v1.2.4 

func WithBufSize(bufSize int) Option

WithBufSize sets a custom buf size for reader

func WithFilter 

func WithFilter(filter string) Option

WithFilter sets a filter to the client

func WithHandler 

func WithHandler(handler func(packet string)) Option

WithHandler sets default packet handler to custom

func WithLogger 

func WithLogger(logger aprsutils.Logger) Option

WithLogger sets default logger to custom

func WithRetryTimes 

func WithRetryTimes(retryTimes int) Option

WithRetryTimes sets a retry times to custom

func WithSoftwareAndVersion 

func WithSoftwareAndVersion(software string, version string) Option

WithSoftwareAndVersion sets default software name and version to custom

type Protocol 

type Protocol string

Protocol is a ENUM type for client protocol 

const (
	TCP Protocol = "tcp"
	UDP Protocol = "udp"
)

type Stats 

type Stats struct {
	TotalSentBytes  uint64        `json:"totalSentBytes"`
	TotalRecvBytes  uint64        `json:"totalRecvBytes"`
	CurrentSentRate uint64        `json:"currentSentRate"`
	CurrentRecvRate uint64        `json:"currentRecvRate"`
	PacketsSent     uint64        `json:"packetsSent"`
	PacketsReceived uint64        `json:"packetsReceived"`
	ConnectionTime  time.Duration `json:"connectionTime"`
	LastActivity    time.Time     `json:"lastActivity"`
}

Stats contains statistics for the client

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.