hooks

Documentation

Overview

Package hooks contains hook implementations.

Index

• func OnConnect(params OnConnectParams) func()
• func OnDemand(params OnDemandParams) func(string)
• func OnInit(params OnInitParams) func()
• func OnRead(params OnReadParams) func()
• func OnReady(params OnReadyParams) func()
• type OnConnectParams
• type OnDemandParams
• type OnInitParams
• type OnReadParams
• type OnReadyParams

Functions

func OnConnect

func OnConnect(params OnConnectParams) func()

OnConnect is the OnConnect hook.

func OnDemand

func OnDemand(params OnDemandParams) func(string)

OnDemand is the OnDemand hook.

func OnInit

func OnInit(params OnInitParams) func()

OnInit is the OnInit hook.

func OnRead

func OnRead(params OnReadParams) func()

OnRead is the OnRead hook.

func OnReady

func OnReady(params OnReadyParams) func()

OnReady is the OnReady hook.

Types

type OnConnectParams

type OnConnectParams struct {
	Logger              logger.Writer
	ExternalCmdPool     *externalcmd.Pool
	RunOnConnect        string
	RunOnConnectRestart bool
	RunOnDisconnect     string
	RTSPAddress         string
	Desc                defs.APIPathSourceOrReader
}

OnConnectParams are the parameters of OnConnect.

type OnDemandParams

type OnDemandParams struct {
	Logger          logger.Writer
	ExternalCmdPool *externalcmd.Pool
	Conf            *conf.Path
	ExternalCmdEnv  externalcmd.Environment
	Query           string
}

OnDemandParams are the parameters of OnDemand.

type OnInitParams

type OnInitParams struct {
	Logger          logger.Writer
	ExternalCmdPool *externalcmd.Pool
	Conf            *conf.Path
	ExternalCmdEnv  externalcmd.Environment
}

OnInitParams are the parameters of OnInit.

type OnReadParams

type OnReadParams struct {
	Logger          logger.Writer
	ExternalCmdPool *externalcmd.Pool
	Conf            *conf.Path
	ExternalCmdEnv  externalcmd.Environment
	Reader          defs.APIPathSourceOrReader
	Query           string
}

OnReadParams are the parameters of OnRead.

type OnReadyParams

type OnReadyParams struct {
	Logger          logger.Writer
	ExternalCmdPool *externalcmd.Pool
	Conf            *conf.Path
	ExternalCmdEnv  externalcmd.Environment
	Desc            defs.APIPathSourceOrReader
	Query           string
}

OnReadyParams are the parameters of OnReady.