connection

Documentation

Index

• type Connection
  • func NewDefaultConnection() (Connection, error)

Types

type Connection

type Connection interface {
	// Open should be called before use
	Open() error
	// Methods to read, write and close the connection
	io.ReadWriteCloser
}

Connection represents a connection to the parsec service.

func NewDefaultConnection

func NewDefaultConnection() (Connection, error)

NewDefaultConnection opens the default connection to the parsec service. This returns a Connection. If the PARSEC_SERVICE_ENDPOINT environment variable is set, then this will be used to determine how to connect to the parsec service. This must be a valid URL, and currently only urls of the form unix:/path are supported. if the PARSEC_SERVICE_ENDPOINT environment variable is not set, then the default of unix:/run/parsec/parsec.sock will be used Connection implementations are not guaranteed to be thread safe, so should not be used across threads.