endpoint

Documentation

Index

• Constants
• Variables
• type Endpoint
  • func New(url *url.URL) *Endpoint
  • func (e *Endpoint) Close() error
  • func (e *Endpoint) Listener(ctx context.Context) (net.Listener, error)

Constants

const (
	SchemeUNIX = "unix"
	SchemeTCP  = "tcp"
)

Schemes supported by COSI.

Variables

var ErrEmptyAddress = errors.New("address is empty")

Types

type Endpoint

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

Endpoint represents COSI Endpoint.

func New

func New(url *url.URL) *Endpoint

New creates a new COSI Endpoint with the specified URL. The URL defines the communication protocol and address for the endpoint.

func (*Endpoint) Close

func (e *Endpoint) Close() error

Close ensures that the UNIX socket is removed after the application is closed.

func (*Endpoint) Listener

func (e *Endpoint) Listener(ctx context.Context) (net.Listener, error)

Listener will return listener (and error) after first configuring it. Listener is configured only once, on the first call, and the error is captured. Every subsequent call will return the same values.