types

Documentation

Index

• Constants
• type LogInterface
• type Once
  • func (o *Once) Do(f func()) bool
• type OnceWait
  • func (o *OnceWait) Do(f func()) bool
• type RetainObject
• type TopicMessenger

Constants

const (
	DefaultKeepAlive        = 60 // DefaultKeepAlive default keep
	DefaultConnectTimeout   = 5  // DefaultConnectTimeout connect timeout
	DefaultMaxPacketSize    = 268435455
	DefaultReceiveMax       = 65535
	DefaultAckTimeout       = 20 // DefaultAckTimeout ack timeout
	DefaultTimeoutRetries   = 3  // DefaultTimeoutRetries retries
	MinKeepAlive            = 30
	DefaultSessionsProvider = "mem"         // DefaultSessionsProvider default session provider
	DefaultAuthenticator    = "mockSuccess" // DefaultAuthenticator default auth provider
	DefaultTopicsProvider   = "mem"         // DefaultTopicsProvider default topics provider
)

Default configs

Types

type LogInterface

type LogInterface struct {
	Prod *zap.Logger
	Dev  *zap.Logger
}

LogInterface inherited by internal packages to provide hierarchical logs

type Once

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

Once is an object that will perform exactly one action.

func (*Once) Do

func (o *Once) Do(f func()) bool

Do calls the function f if and only if Do is being called for the first time for this instance of Once. In other words, given

var once Once

if once.Do(f) is called multiple times, only the first call will invoke f, even if f has a different value in each invocation. A new instance of Once is required for each function to execute.

Do is intended for initialization that must be run exactly once. Since f is niladic, it may be necessary to use a function literal to capture the arguments to a function to be invoked by Do:

config.once.Do(func() { config.init(filename) })

Because no call to Do returns until the one call to f returns, if f causes Do to be called, it will deadlock.

If f panics, Do considers it to have returned; future calls of Do return without calling f.

type OnceWait

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

OnceWait is an object that will perform exactly one action.

func (*OnceWait) Do

func (o *OnceWait) Do(f func()) bool

Do calls the function f if and only if Do is being called for the first time for this instance of Once. In other words, given

var once Once

if once.Do(f) is called multiple times, only the first call will invoke f, even if f has a different value in each invocation. A new instance of Once is required for each function to execute.

Do is intended for initialization that must be run exactly once. Since f is niladic, it may be necessary to use a function literal to capture the arguments to a function to be invoked by Do:

config.once.Do(func() { config.init(filename) })

Because no call to Do returns until the one call to f returns, if f causes Do to be called, it will deadlock.

If f panics, Do considers it to have returned; future calls of Do return without calling f.

type RetainObject

type RetainObject interface {
	Topic() string
}

RetainObject general interface of the retain as not only publish message can be retained

type TopicMessenger

type TopicMessenger interface {
	Publish(interface{}) error
	Retain(RetainObject) error
}

TopicMessenger interface for session or systree used to publish or retain messages