ships

package
v0.3.13 Latest Latest
Warning

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

 Go to latest Published: Jan 18, 2022 License: AGPL-3.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	BaseMTU           = 1460 // 1500 with 40 bytes extra space for special cases.
	IPv4HeaderMTUSize = 20   // Without options, as not common.
	IPv6HeaderMTUSize = 40   // Without options, as not common.
	TCPHeaderMTUSize  = 60   // Maximum size with options.
	UDPHeaderMTUSize  = 8    // Has no options.
)

Variables

View Source 
var (
	ErrSunk = errors.New("ship sunk")
)

Functions

func EnableMasking added in v0.3.0 

func EnableMasking(salt []byte)

EnableMasking enables masking with the given salt.

func Protocols 

func Protocols() []string

Protocols returns a slice with all registered protocol names. The return slice must not be edited.

func Register 

func Register(protocol string, builder *Builder)

Register registers a new builder for a protocol.

Types

type Builder 

type Builder struct {
	LaunchShip    func(ctx context.Context, transport *hub.Transport, ip net.IP) (Ship, error)
	EstablishPier func(transport *hub.Transport, dockingRequests chan *DockingRequest) (Pier, error)
}

Builder is a factory that can build ships and piers of it's protocol.

func GetBuilder 

func GetBuilder(protocol string) *Builder

GetBuilder returns the builder for the given protocol, or nil if it does not exist.

type DockingRequest 

type DockingRequest struct {
	Pier Pier
	Ship Ship
	Err  error
}

DockingRequest is a uniform request that Piers emit when a new ship arrives.

type KCPPier 

type KCPPier struct {
	PierBase
}

KCPPier is a pier that uses KCP.

type KCPShip 

type KCPShip struct {
	ShipBase
}

KCPShip is a ship that uses KCP.

type Pier 

type Pier interface {
	// String returns a human readable informational summary about the ship.
	String() string

	// Transport returns the transport used for this ship.
	Transport() *hub.Transport

	// Docking is the blocking (!) procedure that docks new ships and sends docking requests. This should be run as a worker by the caller.
	Docking(ctx context.Context) error

	// Addr returns the underlying network address used by the listener.
	Addr() net.Addr

	// Abolish closes the underlying listener and cleans up any related resources.
	Abolish()
}

Pier represents a network connection listener.

func EstablishPier 

func EstablishPier(transport *hub.Transport, dockingRequests chan *DockingRequest) (Pier, error)

EstablishPier is shorthand function to get the transport's builder and establish a pier.

type PierBase 

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

PierBase implements common functions to comply with the Pier interface.

func (*PierBase) Abolish 

func (pier *PierBase) Abolish()

Abolish closes the underlying listener and cleans up any related resources.

func (*PierBase) Addr 

func (pier *PierBase) Addr() net.Addr

Addr returns the underlying network address used by the listener.

func (*PierBase) Docking 

func (pier *PierBase) Docking(ctx context.Context) error

Docking is the blocking (!) procedure that docks new ships and sends docking requests. This should be run as a worker by the caller.

func (*PierBase) String 

func (pier *PierBase) String() string

String returns a human readable informational summary about the ship.

func (*PierBase) Transport 

func (pier *PierBase) Transport() *hub.Transport

Transport returns the transport used for this ship.

type Ship 

type Ship interface {
	// String returns a human readable informational summary about the ship.
	String() string

	// Transport returns the transport used for this ship.
	Transport() hub.Transport

	// IsMine returns whether the ship was launched from here.
	IsMine() bool

	// IsSecure returns whether the ship provides transport security.
	IsSecure() bool

	// Public returns whether the ship is marked as public.
	Public() bool

	// MarkPublic marks the ship as public.
	MarkPublic()

	// LoadSize returns the recommended data size that should be handed to Load().
	// This value will be most likely somehow related to the connection's MTU.
	// Alternatively, using a multiple of LoadSize is also recommended.
	LoadSize() int

	// Load loads data into the ship - ie. sends the data via the connection.
	// Returns ErrSunk if the ship has already sunk earlier.
	Load(data []byte) error

	// UnloadTo unloads data from the ship - ie. receives data from the
	// connection - puts it into the buf. It returns the amount of data
	// written and an optional error.
	// Returns ErrSunk if the ship has already sunk earlier.
	UnloadTo(buf []byte) (n int, err error)

	// LocalAddr returns the underlying local net.Addr of the connection.
	LocalAddr() net.Addr

	// RemoteAddr returns the underlying remote net.Addr of the connection.
	RemoteAddr() net.Addr

	// Sink closes the underlying connection and cleans up any related resources.
	Sink()

	MaskAddress(addr net.Addr) string
	MaskIP(ip net.IP) string
	Mask(value []byte) string
}

Ship represents a network layer connection.

func Launch added in v0.3.0 

func Launch(ctx context.Context, h *hub.Hub, transport *hub.Transport, ip net.IP) (Ship, error)

type ShipBase 

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

ShipBase implements common functions to comply with the Ship interface.

func (*ShipBase) IsMine 

func (ship *ShipBase) IsMine() bool

IsMine returns whether the ship was launched from here.

func (*ShipBase) IsSecure added in v0.3.0 

func (ship *ShipBase) IsSecure() bool

IsSecure returns whether the ship provides transport security.

func (*ShipBase) Load 

func (ship *ShipBase) Load(data []byte) error

Load loads data into the ship - ie. sends the data via the connection. Returns ErrSunk if the ship has already sunk earlier.

func (*ShipBase) LoadSize added in v0.3.0 

func (ship *ShipBase) LoadSize() int

LoadSize returns the recommended data size that should be handed to Load(). This value will be most likely somehow related to the connection's MTU. Alternatively, using a multiple of LoadSize is also recommended.

func (*ShipBase) LocalAddr 

func (ship *ShipBase) LocalAddr() net.Addr

LocalAddr returns the underlying local net.Addr of the connection.

func (*ShipBase) MarkPublic added in v0.3.0 

func (ship *ShipBase) MarkPublic()

MarkPublic marks the ship as public.

func (*ShipBase) Mask added in v0.3.0 

func (ship *ShipBase) Mask(value []byte) string

Mask masks the given value.

func (*ShipBase) MaskAddress added in v0.3.0 

func (ship *ShipBase) MaskAddress(addr net.Addr) string

MaskAddress masks the given address if masking is enabled and the ship is not public.

func (*ShipBase) MaskIP added in v0.3.0 

func (ship *ShipBase) MaskIP(ip net.IP) string

MaskIP masks the given IP if masking is enabled and the ship is not public.

func (*ShipBase) Public added in v0.3.0 

func (ship *ShipBase) Public() bool

Public returns whether the ship is marked as public.

func (*ShipBase) RemoteAddr 

func (ship *ShipBase) RemoteAddr() net.Addr

RemoteAddr returns the underlying remote net.Addr of the connection.

func (*ShipBase) Sink 

func (ship *ShipBase) Sink()

Sink closes the underlying connection and cleans up any related resources.

func (*ShipBase) String 

func (ship *ShipBase) String() string

String returns a human readable informational summary about the ship.

func (*ShipBase) Transport 

func (ship *ShipBase) Transport() hub.Transport

Transport returns the transport used for this ship.

func (*ShipBase) UnloadTo 

func (ship *ShipBase) UnloadTo(buf []byte) (n int, err error)

UnloadTo unloads data from the ship - ie. receives data from the connection - puts it into the buf. It returns the amount of data written and an optional error. Returns ErrSunk if the ship has already sunk earlier.

type TCPPier 

type TCPPier struct {
	PierBase
}

TCPPier is a pier that uses TCP.

type TCPShip 

type TCPShip struct {
	ShipBase
}

TCPShip is a ship that uses TCP.

type TestShip 

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

TestShip is a simulated ship that is used for testing higher level components.

func NewTestShip 

func NewTestShip(secure bool, loadSize int) *TestShip

NewTestShip returns a new TestShip for simulation.

func (*TestShip) IsMine 

func (d *TestShip) IsMine() bool

IsMine returns whether the ship was launched from here.

func (*TestShip) IsSecure added in v0.3.0 

func (d *TestShip) IsSecure() bool

IsSecure returns whether the ship provides transport security.

func (*TestShip) Load 

func (ship *TestShip) Load(data []byte) error

Load loads data into the ship - ie. sends the data via the connection. Returns ErrSunk if the ship has already sunk earlier.

func (*TestShip) LoadSize added in v0.3.0 

func (d *TestShip) LoadSize() int

LoadSize returns the recommended data size that should be handed to Load(). This value will be most likely somehow related to the connection's MTU. Alternatively, using a multiple of LoadSize is also recommended.

func (*TestShip) LocalAddr 

func (d *TestShip) LocalAddr() net.Addr

func (*TestShip) MarkPublic added in v0.3.0 

func (d *TestShip) MarkPublic()

func (*TestShip) Mask added in v0.3.0 

func (d *TestShip) Mask(value []byte) string

func (*TestShip) MaskAddress added in v0.3.0 

func (d *TestShip) MaskAddress(addr net.Addr) string

func (*TestShip) MaskIP added in v0.3.0 

func (d *TestShip) MaskIP(ip net.IP) string

func (*TestShip) Public added in v0.3.0 

func (d *TestShip) Public() bool

func (*TestShip) RemoteAddr 

func (d *TestShip) RemoteAddr() net.Addr

func (*TestShip) Reverse 

func (d *TestShip) Reverse() *TestShip

Reverse creates a connected TestShip. This is used to simulate a connection instead of using a Pier.

func (*TestShip) Sink 

func (d *TestShip) Sink()

Sink closes the underlying connection and cleans up any related resources.

func (*TestShip) String 

func (d *TestShip) String() string

String returns a human readable informational summary about the ship.

func (*TestShip) Transport 

func (d *TestShip) Transport() hub.Transport

Transport returns the transport used for this ship.

func (*TestShip) UnloadTo 

func (ship *TestShip) UnloadTo(buf []byte) (n int, err error)

UnloadTo unloads data from the ship - ie. receives data from the connection - puts it into the buf. It returns the amount of data written and an optional error. Returns ErrSunk if the ship has already sunk earlier.

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.