Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

ctrl

package

Go to main page

Versions in this module

v1

v1.4.1

Feb 6, 2026

Changes in this version

+ func ForkDetectedDataToChannelEventThread() error

type Channel

+ DetectedData *xctrl.DetectedData

type Ctrl

+ func (h *Ctrl) ForkDetectedDataToChannelEventThread() error

v1.4.0

Feb 3, 2026

v1.3.7

Feb 3, 2026

v1.3.6

Jan 16, 2026

Changes in this version

+ func ACall(subject string, method string, req interface{}, opts ...*AsyncCallOption) error

+ func AService() xctrl.XNodeService

+ func AsyncService() xctrl.XNodeService

+ func CManService() cman.CManService

+ func Call(topic string, req *Request, timeout time.Duration) (*nats.Message, error)

+ func ContextWithID(id string) context.Context

+ func CtrlStartUp(req *xctrl.CtrlStartUpRequest) error

+ func DelChannel(uuid string) error

+ func DeliverToChannelEventThread(channel *Channel, natsEvent nats.Event)

+ func Disconnect() error

+ func DoResultCallback(msg *Message)

+ func EnableApp(handler AppHandler, subject string, queue string) error

+ func EnableEvent(handler EventHandler, subject string, queue string) error

+ func EnableNodeStatus(subject string) error

+ func EnableRequest(handler RequestHandler, subject string, queue string) error

+ func EnableTenancy()

+ func ForkDTMFEventToChannelEventThread() error

+ func GetChannelState(uuid string) string

+ func GetNATSConn() *natsio.Conn

+ func GetNodeList() map[string]*xctrl.Node

+ func GetTenancyTopicAddress(userPrefix string, topic string) string

+ func GetTenancyTopicAndUser(rawTopic string) (user string, topic string)

+ func GetTenantID(subject string) string

+ func GetTenantId(subject string) string

+ func Hostname(uuid string) string

+ func Init(trace bool, addrs string) error

+ func InitCManService(addr string) error

+ func InitMock(c client.Client) error

+ func InitWithConfig(config CtrlConfig) error

+ func InitWithUUID(trace bool, addrs string, uuid string) error

+ func Node(hostname string) *xctrl.Node

+ func NodeAddress(nodeUUID string) string

+ func OnEvicted(f func(string, interface{}))

+ func Publish(topic string, msg []byte, opts ...nats.PublishOption) error

+ func PublishJSON(topic string, obj interface{}, opts ...nats.PublishOption) error

+ func RawMessage(data []byte) *json.RawMessage

+ func RegisterHashNodeFun(nodeCallbackFunc NodeHashFun)

+ func RegisterHashNodeWithTenancyFun(nodeCallbackFunc NodeHashWithTenacyFun)

+ func Respond(topic string, resp *Response, opts ...nats.PublishOption) error

+ func Service() xctrl.XNodeService

+ func SetFromPrefix(prefix string)

+ func SetLogLevel(level LogLevel)

+ func SetLogger(l Logger)

+ func SetMaxChannelLifeTime(time uint)

+ func SetMaxChannelLifeTimeMinute(time uint)

+ func SetToPrefix(prefix string)

+ func Subscribe(subject string, cb nats.EventCallback, queue string) (nats.Subscriber, error)

+ func TenantNodeAddress(tenant string, nodeUUID string) string

+ func ToRawMessage(vPoint interface{}) *json.RawMessage

+ func Transfer(ctrlID string, channel *xctrl.ChannelEvent) error

+ func TranslateMethod(method string) string

+ func UUID() string

+ func WithAddress(nodeUUID string) client.CallOption

+ func WithAddressDefault() client.CallOption

+ func WithAsync() client.CallOption

+ func WithRequestTimeout(d time.Duration) client.CallOption

+ func WithTenantAddress(tenant string, nodeUUID string) client.CallOption

+ func WithTimeout(d time.Duration) client.CallOption

+ func XCall(topic string, method string, params interface{}, timeout time.Duration) (*nats.Message, error)

+ type AppHandler interface

+ ChannelEvent func(context.Context, *Channel)

+ Event func(msg *Message, natsEvent nats.Event)

+ type AsyncCallOption struct

+ func ACallOption() *AsyncCallOption

+ func (opt *AsyncCallOption) WithCallback(f ResultCallbackFunc) *AsyncCallOption

+ func (opt *AsyncCallOption) WithData(data interface{}) *AsyncCallOption

+ type Channel struct

+ CtrlUuid string

+ func FindChannel(condition string, argument string) []*Channel

+ func NewChannel(channel_uuid string) *Channel

+ func NewChannelEvent() *Channel

+ func NewChannelEventWithPrefix(prefix string) *Channel

+ func ReadChannel(uuid string) (*Channel, error)

+ func ReadChannelByInstance(c *Ctrl, uuid string) (*Channel, error)

+ func WriteChannel(uuid string, channel *Channel) *Channel

+ func (channel *Channel) Accept0(opts ...client.CallOption) *xctrl.Response

+ func (channel *Channel) AcceptAndTakeOver(opts ...client.CallOption) *xctrl.Response

+ func (channel *Channel) AcceptWithChannelParams(channel_params []string, opts ...client.CallOption) *xctrl.Response

+ func (channel *Channel) AcceptWithChannelParamsAndTakeOver(channel_params []string, opts ...client.CallOption) *xctrl.Response

+ func (channel *Channel) Answer0(opts ...client.CallOption) *xctrl.Response

+ func (channel *Channel) AnswerWithChannelParams(channel_params []string, opts ...client.CallOption) *xctrl.Response

+ func (channel *Channel) Bridge0(req *xctrl.BridgeRequest, async bool) *xctrl.Response

+ func (channel *Channel) DetectSpeech0(req *xctrl.DetectRequest, async bool) *xctrl.DetectResponse

+ func (channel *Channel) DetectSpeechFeedTTS0(req *xctrl.DetectSpeechFeedTTSRequest, async bool) *xctrl.Response

+ func (channel *Channel) FullCtrlUuid() string

+ func (channel *Channel) GetChannelEvent() *xctrl.ChannelEvent

+ func (channel *Channel) GetNatsEvent() nats.Event

+ func (channel *Channel) GetTenantID() string

+ func (channel *Channel) GetUserData() interface{}

+ func (channel *Channel) GetVariable0(key string) string

+ func (channel *Channel) Hangup0(cause string, flag xctrl.HangupRequest_HangupFlag) *xctrl.Response

+ func (channel *Channel) Marshal() []byte

+ func (channel *Channel) MediaFork(req *xctrl.MediaForkRequest) *xctrl.MediaForkResponse

+ func (channel *Channel) NodeAddress() client.CallOption

+ func (channel *Channel) Play0(req *xctrl.PlayRequest) *xctrl.Response

+ func (channel *Channel) PlayFile(file string, opts ...client.CallOption) *xctrl.Response

+ func (channel *Channel) PlayTTS(engine string, voice string, text string, opts ...client.CallOption) *xctrl.Response

+ func (channel *Channel) PlayWithTimeout(req *xctrl.PlayRequest, timeout time.Duration) *xctrl.Response

+ func (channel *Channel) Ready() bool

+ func (channel *Channel) RingBackDetection0(req *xctrl.RingBackDetectionRequest, async bool) *xctrl.Response

+ func (channel *Channel) Save() *Channel

+ func (channel *Channel) SendDTMF0(dtmf string) *xctrl.Response

+ func (channel *Channel) SetUserData(userData interface{})

+ func (channel *Channel) SetVariable0(key, value string) error

+ func (channel *Channel) SetVariables(vars map[string]string) error

+ func (channel *Channel) Stop0() *xctrl.Response

+ func (channel *Channel) String() string

+ func (channel *Channel) Subscribe(subject string, cb nats.EventCallback, queue string) (nats.Subscriber, error)

+ type ContextKey string

+ type Ctrl struct

+ func NewCtrlInstance(trace bool, addrs string) (*Ctrl, error)

+ func (c *Ctrl) AService() xctrl.XNodeService

+ func (c *Ctrl) AsyncService() xctrl.XNodeService

+ func (c *Ctrl) CManService() cman.CManService

+ func (c *Ctrl) Call(topic string, req *Request, timeout time.Duration) (*nats.Message, error)

+ func (c *Ctrl) CtrlStartUp(req *xctrl.CtrlStartUpRequest) error

+ func (c *Ctrl) GetInstanceName() string

+ func (c *Ctrl) GetNATSConn() *natsio.Conn

+ func (c *Ctrl) GetNodeList() map[string]*xctrl.Node

+ func (c *Ctrl) GetTenancyTopicAddress(userPrefix string, topic string) string

+ func (c *Ctrl) GetTenancyTopicAndUser(rawTopic string) (user string, topic string)

+ func (c *Ctrl) GetTenantID(subject string) string

+ func (c *Ctrl) GetTenantId(subject string) string

+ func (c *Ctrl) Publish(topic string, msg []byte, opts ...nats.PublishOption) error

+ func (c *Ctrl) PublishJSON(topic string, obj interface{}, opts ...nats.PublishOption) error

+ func (c *Ctrl) Respond(topic string, resp *Response, opts ...nats.PublishOption) error

+ func (c *Ctrl) Service() xctrl.XNodeService

+ func (c *Ctrl) SetFromPrefix(prefix string)

+ func (c *Ctrl) SetInstanceName(instanceName string)

+ func (c *Ctrl) SetMaxChannelLifeTime(time uint)

+ func (c *Ctrl) SetMaxChannelLifeTimeMinute(time uint)

+ func (c *Ctrl) SetTenancyStatus(status bool)

+ func (c *Ctrl) SetToPrefix(prefix string)

+ func (c *Ctrl) TenantNodeAddress(tenant string, nodeUUID string) string

+ func (c *Ctrl) Transfer(ctrlID string, channel *xctrl.ChannelEvent) error

+ func (c *Ctrl) UUID() string

+ func (c *Ctrl) WithTenantAddress(tenant string, nodeUUID string) client.CallOption

+ func (c *Ctrl) XCall(topic string, method string, params interface{}, timeout time.Duration) (*nats.Message, error)

+ func (h *Ctrl) EnableApp(handler AppHandler, subject string, queue string) error

+ func (h *Ctrl) EnableEvent(handler EventHandler, subject string, queue string) error

+ func (h *Ctrl) EnableRequest(handler RequestHandler, subject string, queue string) error

+ func (h *Ctrl) EnbaleNodeStatus(subject string) error

+ func (h *Ctrl) ForkDTMFEventToChannelEventThread() error

+ func (h *Ctrl) NewCManService(addr string) cman.CManService

+ func (h *Ctrl) OnEvicted(f func(string, interface{}))

+ func (h *Ctrl) Subscribe(topic string, cb nats.EventCallback, queue string) (nats.Subscriber, error)

+ type CtrlConfig struct

+ Addrs string

+ CertPem string

+ CtrlUUID string

+ DrainConnection bool

+ KeyPem string

+ RootCAPem string

+ Trace bool

+ type CtrlNodes struct

+ func InitCtrlNodes() CtrlNodes

+ func (c *CtrlNodes) Delete(hostname string)

+ func (c *CtrlNodes) GetNodeList() map[string]*xctrl.Node

+ func (c *CtrlNodes) Hostname(uuid string) string

+ func (c *CtrlNodes) Node(hostname string) *xctrl.Node

+ func (c *CtrlNodes) Store(hostname string, node *xctrl.Node)

+ type EmptyAppHandler struct

+ func (h *EmptyAppHandler) ChannelEvent(context.Context, *Channel)

+ func (h *EmptyAppHandler) Event(*Message, nats.Event)

+ type EmptyEventHandler struct

+ func (h *EmptyEventHandler) Event(*Request)

+ type EmptyRequestHandler struct

+ func (h *EmptyRequestHandler) Request(*Request, nats.Event)

+ type Error struct

+ Code int

+ Data interface{}

+ Message string

+ func NewError(code int, message string) *Error

+ func ServerError(rpcerr error) *Error

+ func (e *Error) Error() string

+ type EventHandler interface

+ Event func(req *Request, natsEvent nats.Event)

+ type LogLevel int

+ const LLDebug

+ const LLError

+ const LLFatal

+ const LLInfo

+ const LLTrace

+ const LLWarn

+ type Logger interface

+ Log func(level int, v ...interface{})

+ Logf func(level int, format string, v ...interface{})

+ type Message struct

+ Error *json.RawMessage

+ ID *json.RawMessage

+ Method string

+ Params *json.RawMessage

+ Result *json.RawMessage

+ Version string

+ func (m *Message) String() string

+ type NodeHashFun func(node *xctrl.Node, method string)

+ type NodeHashWithTenacyFun func(node *xctrl.Node, method string, tenancy string)

+ type Request struct

+ ID *json.RawMessage

+ Method string

+ Params *json.RawMessage

+ Version string

+ func (r *Request) Marshal() []byte

+ func (r *Request) RawMessage() *json.RawMessage

+ type RequestHandler interface

+ Request func(req *Request, natsEvent nats.Event)

+ type Response struct

+ Error interface{}

+ ID *json.RawMessage

+ Result interface{}

+ Version string

+ type Result struct

+ Error *json.RawMessage

+ ID *json.RawMessage

+ Result *json.RawMessage

+ Version string

+ type ResultCallbackFunc func(msg *Message, data interface{})

+ type XRequest struct

+ ID interface{}

+ Method string

+ Params interface{}

+ Version string