types

Documentation

Index

• type Connection
  • func (c *Connection) MarshalJSON() ([]byte, error)
  • func (c *Connection) UnmarshalJSON(v []byte) error
• type Relay
  • func (r *Relay) MarshalJSON() ([]byte, error)
  • func (r *Relay) StartRelay(delay time.Duration) error
  • func (r *Relay) UnmarshalJSON(v []byte) error
• type Tunnel
  • func (d *Tunnel) Close()
  • func (d *Tunnel) MarshalJSON() ([]byte, error)
  • func (d *Tunnel) StartTunnel(delay time.Duration) error
  • func (d *Tunnel) UnmarshalJSON(v []byte) error

Types

type Connection

type Connection struct {
	Connection *opts.ConnectionOptions
}

Connection is a convenience struct wrapping opts.ConnectionOptions so we can marshal Config to JSON. The Marshaler methods are implemented to return a string of protobuf bytes because protobuf oneof's cannot be unmarshalled correctly by json.Unmarshal()

func (*Connection) MarshalJSON

func (c *Connection) MarshalJSON() ([]byte, error)

func (*Connection) UnmarshalJSON

func (c *Connection) UnmarshalJSON(v []byte) error

UnmarshalJSON unmarshals JSON into a connection struct

type Relay

type Relay struct {
	Active     bool               `json:"-"`
	Id         string             `json:"-"`
	CancelCtx  context.Context    `json:"-"`
	CancelFunc context.CancelFunc `json:"-"`
	RelayCh    chan interface{}   `json:"-"`
	Backend    backends.Backend   `json:"-"`
	Options    *opts.RelayOptions `json:"config"`
	// contains filtered or unexported fields
}

func (*Relay) MarshalJSON

func (r *Relay) MarshalJSON() ([]byte, error)

MarshalJSON marshals a tunnel to JSON

func (*Relay) StartRelay

func (r *Relay) StartRelay(delay time.Duration) error

StartRelay starts a configured relay, it's workers, and the GRPC workers; StartRelay will block for "delay" duration, waiting for errors.

func (*Relay) UnmarshalJSON

func (r *Relay) UnmarshalJSON(v []byte) error

UnmarshalJSON unmarshals JSON into a tunnel struct

type Tunnel

type Tunnel struct {
	Active           bool                `json:"-"`
	Id               string              `json:"-"`
	CancelCtx        context.Context     `json:"-"`
	CancelFunc       context.CancelFunc  `json:"-"`
	Backend          backends.Backend    `json:"-"`
	Options          *opts.TunnelOptions `json:"config"`
	TunnelService    tunnel.ITunnel
	PlumberClusterID string `json:"-"`
	// contains filtered or unexported fields
}

func (*Tunnel) Close

func (d *Tunnel) Close()

func (*Tunnel) MarshalJSON

func (d *Tunnel) MarshalJSON() ([]byte, error)

MarshalJSON marshals a tunnel to JSON

func (*Tunnel) StartTunnel

func (d *Tunnel) StartTunnel(delay time.Duration) error

StartTunnel will attempt to start the replay tunnel. Upon the start, it will wait for the given "delay" listening for errors. It will return an error if it encounters any errors on the ErrorChan or if the Tunnel call fails.

Subsequent failures inside of Tunnel() are not handled yet.

func (*Tunnel) UnmarshalJSON

func (d *Tunnel) UnmarshalJSON(v []byte) error

UnmarshalJSON unmarshals JSON into a tunnel struct