rt

Documentation

Index

• type Client
  • func New(hostname, endpoint, key, whepEndpoint string) *Client
  • func (client *Client) Close() error
  • func (client *Client) Connect() error
  • func (client *Client) Heartbeat(channelID types.ChannelID) error
  • func (client *Client) Name() string
  • func (client *Client) SetLogger(log logrus.FieldLogger)
  • func (client *Client) StartStream(channelID types.ChannelID, streamID types.StreamID) error
  • func (client *Client) StopStream(channelID types.ChannelID, streamID types.StreamID) error

Types

type Client

type Client struct {

	// RTRouterEndpoint is the URL of a public RTRouter
	Endpoint string
	// Key is the secret key to be used for stateful changes
	Key string
	// Needs to be hardcoded for now...
	WHEPEndpoint string
	// contains filtered or unexported fields
}

func New

func New(hostname, endpoint, key, whepEndpoint string) *Client

func (*Client) Close

func (client *Client) Close() error

Likely this needs to tell the orchestrator all URLs for this endpoint are no longer valid

func (*Client) Connect

func (client *Client) Connect() error

Since RTRouter is HTTP, no permanent connection is necessary.

func (*Client) Heartbeat

func (client *Client) Heartbeat(channelID types.ChannelID) error

func (*Client) Name

func (client *Client) Name() string

func (*Client) SetLogger

func (client *Client) SetLogger(log logrus.FieldLogger)

func (*Client) StartStream

func (client *Client) StartStream(channelID types.ChannelID, streamID types.StreamID) error

func (*Client) StopStream

func (client *Client) StopStream(channelID types.ChannelID, streamID types.StreamID) error