stream

Documentation

Index

• Constants
• type Proxy
  • func NewTCPProxy(o *TCPProxyOptions) (Proxy, error)
  • func NewUDPProxy(o *UDPProxyOptions) (Proxy, error)
• type SatelliteStream
  • func OpenSatelliteStream(o *SatelliteStreamOptions, recvChan chan<- []byte) (SatelliteStream, error)
• type SatelliteStreamOptions
• type TCPProxyOptions
• type UDPProxyOptions

Constants

const (
	OPEN   uint32 = 0
	CLOSED uint32 = 1
)

Types

type Proxy

type Proxy interface {
	// Close the proxy.
	Close() error
	// Start listening for packets to send to the satellite and sending back received packets.
	Start(o *SatelliteStreamOptions) error
}

Proxy is the interface to send and receive packets.

func NewTCPProxy

func NewTCPProxy(o *TCPProxyOptions) (Proxy, error)

Create a UDPProxy.

func NewUDPProxy

func NewUDPProxy(o *UDPProxyOptions) (Proxy, error)

Create a UDPProxy.

type SatelliteStream

type SatelliteStream interface {
	Send(payload []byte) error

	io.Closer
}

func OpenSatelliteStream

func OpenSatelliteStream(o *SatelliteStreamOptions, recvChan chan<- []byte) (SatelliteStream, error)

OpenSatelliteStream opens a stream to a satellite over the StellarStation API.

type SatelliteStreamOptions

type SatelliteStreamOptions struct {
	AcceptedFraming []stellarstation.Framing
	SatelliteID     string
	IsVerbose       bool
}

type TCPProxyOptions

type TCPProxyOptions struct {
	Addr string
}

type UDPProxyOptions

type UDPProxyOptions struct {
	RecvAddr string
	SendAddr string
}