protocol

package

v0.5.7 Latest Latest Go to latest Published: Jun 14, 2021 License: MIT Imports: 1 Imported by: 0

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

Package protocol holds structs and other constructs that are used by the network transport for cross-network RPC calls

View Source

const (
	// RPCName is the name/prefix used for RPC methods
	RPCName = "NetworkRPC"
)

This section is empty.

This section is empty.

type ProcessExit struct {
	Return    int
	StrReturn string
	Error     SerialiseError
}

ProcessExit represents all available information regarding a process that has exited

type SerialiseError struct {
	ErrorStr string
	IsError  bool
}

SerialiseError is an error struct that is safe to transfer over a gob encoding

func SErrorFromError(err error) SerialiseError

SErrorFromError converts an error to a SerializeError

func SErrorFromString(str string) SerialiseError

SErrorFromString creates a SerialiseError from the given string

func (s *SerialiseError) ToError() error

ToError converts a SerialiseError to an error interface

type StdIOLine struct {
	Line   string
	Stdout bool
	ID     int64
}

StdIOLine holds a single line from a process sent over StdIO

type StdIOLines struct {
	Lines []StdIOLine
	// Stdout bool
	Error SerialiseError
}

StdIOLines holds a set of lines for processing