io

package module

v0.0.0-...-7447419 Latest Latest Go to latest Published: Feb 23, 2024 License: AGPL-3.0 Imports: 6 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

io describes the Sandwich I/O interface. The I/O interface is used by the implementation to perform all i/o operation.

This section is empty.

This section is empty.

This section is empty.

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

IO is a Sandwich IO.

func NewIO(readWriter io.ReadWriter) *IO

NewIO creates a new IO from a io.ReadWriter

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

Listener is a listener that accepts connections and returns IOs.

func NewListener(configuration *api.ListenerConfiguration) (*Listener, error)

NewListener creates a new Sandwich listener from a protobuf configuration.

func (listener *Listener) Accept() (*OwnedIO, *swerrors.IOError)

Write implements the sandwich.IO interface for bufIO.

func (listener *Listener) Close()

func (listener *Listener) Listen() *swerrors.IOError

Reads implements the sandwich.IO interface for bufIO.

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

OwnedIO is a Sandwich IO owned by Sandwich.

func IOTCPClient(hostname string, port uint16) (*OwnedIO, *swerrors.IOError)

Creates a Sandwich owned TCP based IO Object.

func IOTurboClient(udp_hostname string, udp_port uint16, tcp_hostname string, tcp_port uint16) (*OwnedIO, *swerrors.IOError)

Creates a Sandwich owned Turbo based IO Object.

func (ownedIO *OwnedIO) Read(b []byte) (int, error)

Read implements io.Read.

func (ownedIO *OwnedIO) Write(b []byte) (int, error)

Write implements io.Write.