proxy

Documentation

Overview

Package proxy provides utilities for interacting with QLab over TCP

Index

• func DiscoverQlabServices() ([]*zeroconf.ServiceEntry, error)
• func GetOutboundIP() net.IP
• func HandleOsc(q *QlabTcpClient, pathPrefix string) http.Handler
• func HandleStatic(files embed.FS, dir string) func(w http.ResponseWriter, r *http.Request)
• func PromptServiceSelection() string
• type QlabTcpClient
  • func NewTcpClient(qlabAddress string) *QlabTcpClient
  • func (q *QlabTcpClient) Listen(ready chan struct{})
  • func (q *QlabTcpClient) Send(oscAddress string, oscArguments []string, expectResponse bool) (string, error)
  • func (q *QlabTcpClient) WritePacket(oscAddress string, oscArguments []string) error

Functions

func DiscoverQlabServices

func DiscoverQlabServices() ([]*zeroconf.ServiceEntry, error)

func GetOutboundIP

func GetOutboundIP() net.IP

GetOutboundIP returns the host IP this API responds to

func HandleOsc

func HandleOsc(q *QlabTcpClient, pathPrefix string) http.Handler

func HandleStatic

func HandleStatic(files embed.FS, dir string) func(w http.ResponseWriter, r *http.Request)

func PromptServiceSelection

func PromptServiceSelection() string

Types

type QlabTcpClient

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

func NewTcpClient

func NewTcpClient(qlabAddress string) *QlabTcpClient

NewTcpClient creates a new client

func (*QlabTcpClient) Listen

func (q *QlabTcpClient) Listen(ready chan struct{})

Listen dials the QlabTcpClient address and sends a ready signal when able to send OSC messages

func (*QlabTcpClient) Send

func (q *QlabTcpClient) Send(oscAddress string, oscArguments []string, expectResponse bool) (string, error)

Send sends an osc message over tcp if expectResponse is true it will wait up to 3 seconds to return a corresponding reply message

func (*QlabTcpClient) WritePacket

func (q *QlabTcpClient) WritePacket(oscAddress string, oscArguments []string) error

WritePacket encodes an OSC message and writes it to the connection using the SLIP protocol