gocent

package module

Go to main page

Versions in this module

v3

v3.3.0

Jul 20, 2024

Changes in this version

type ErrStatusCode

+ Body []byte

v3.2.0

Jan 26, 2022

v3.1.0

Oct 26, 2021

Changes in this version

type Client

+ func (c *Client) Subscribe(ctx context.Context, channel, user string, opts ...SubscribeOption) error

type Pipe

+ func (p *Pipe) AddSubscribe(channel string, user string, opts ...SubscribeOption) error

v3.0.0

Sep 3, 2021

Changes in this version

+ const NoLimit

+ var DefaultHTTPClient = &http.Client

+ var ErrMalformedResponse = errors.New("malformed response returned from server")

+ var ErrPipeEmpty = errors.New("no commands in pipe")

+ type BroadcastResult struct

+ Responses []PublishResponse

+ type ChannelInfo struct

+ NumUsers int32

+ type ChannelsOption func(options *ChannelsOptions)

+ func WithPattern(pattern string) ChannelsOption

+ type ChannelsOptions struct

+ Pattern string

+ type ChannelsResult struct

+ Channels map[string]ChannelInfo

+ type Client struct

+ func New(c Config) *Client

+ func (c *Client) Broadcast(ctx context.Context, channels []string, data []byte, opts ...PublishOption) (BroadcastResult, error)

+ func (c *Client) Channels(ctx context.Context, opts ...ChannelsOption) (ChannelsResult, error)

+ func (c *Client) Disconnect(ctx context.Context, user string, opts ...DisconnectOption) error

+ func (c *Client) History(ctx context.Context, channel string, opts ...HistoryOption) (HistoryResult, error)

+ func (c *Client) HistoryRemove(ctx context.Context, channel string) error

+ func (c *Client) Info(ctx context.Context) (InfoResult, error)

+ func (c *Client) Pipe() *Pipe

+ func (c *Client) Presence(ctx context.Context, channel string) (PresenceResult, error)

+ func (c *Client) PresenceStats(ctx context.Context, channel string) (PresenceStatsResult, error)

+ func (c *Client) Publish(ctx context.Context, channel string, data []byte, opts ...PublishOption) (PublishResult, error)

+ func (c *Client) SendPipe(ctx context.Context, pipe *Pipe) ([]Reply, error)

+ func (c *Client) SetHTTPClient(httpClient *http.Client)

+ func (c *Client) Unsubscribe(ctx context.Context, channel, user string, opts ...UnsubscribeOption) error

+ type ClientInfo struct

+ ChanInfo json.RawMessage

+ Client string

+ ConnInfo json.RawMessage

+ User string

+ type Command struct

+ Method string

+ Params interface{}

+ type Config struct

+ Addr string

+ GetAddr func() (string, error)

+ HTTPClient *http.Client

+ Key string

+ type Disconnect struct

+ Code uint32

+ Reason string

+ Reconnect bool

+ type DisconnectOption func(options *DisconnectOptions)

+ func WithDisconnect(disconnect *Disconnect) DisconnectOption

+ func WithDisconnectClient(clientID string) DisconnectOption

+ func WithDisconnectClientWhitelist(whitelist []string) DisconnectOption

+ type DisconnectOptions struct

+ ClientID string

+ ClientWhitelist []string

+ Disconnect *Disconnect

+ type ErrStatusCode struct

+ Code int

+ func (e ErrStatusCode) Error() string

+ type Error struct

+ Code int

+ Message string

+ func (e Error) Error() string

+ type HistoryOption func(options *HistoryOptions)

+ func WithLimit(limit int) HistoryOption

+ func WithReverse(reverse bool) HistoryOption

+ func WithSince(sp *StreamPosition) HistoryOption

+ type HistoryOptions struct

+ Limit int

+ Reverse bool

+ Since *StreamPosition

+ type HistoryResult struct

+ Epoch string

+ Offset uint64

+ Publications []Publication

+ type InfoResult struct

+ Nodes []NodeInfo

+ type NodeInfo struct

+ Name string

+ NumChannels int

+ NumClients int

+ NumUsers int

+ UID string

+ Uptime int

+ Version string

+ type Pipe struct

+ func (p *Pipe) AddBroadcast(channels []string, data []byte, opts ...PublishOption) error

+ func (p *Pipe) AddChannels(opts ...ChannelsOption) error

+ func (p *Pipe) AddDisconnect(user string, opts ...DisconnectOption) error

+ func (p *Pipe) AddHistory(channel string, opts ...HistoryOption) error

+ func (p *Pipe) AddHistoryRemove(channel string) error

+ func (p *Pipe) AddInfo() error

+ func (p *Pipe) AddPresence(channel string) error

+ func (p *Pipe) AddPresenceStats(channel string) error

+ func (p *Pipe) AddPublish(channel string, data []byte, opts ...PublishOption) error

+ func (p *Pipe) AddUnsubscribe(channel string, user string, opts ...UnsubscribeOption) error

+ func (p *Pipe) Reset()

+ type PresenceResult struct

+ Presence map[string]ClientInfo

+ type PresenceStatsResult struct

+ NumClients int32

+ NumUsers int32

+ type Publication struct

+ Data json.RawMessage

+ Info *ClientInfo

+ Offset uint64

+ type PublishOption func(*PublishOptions)

+ func WithSkipHistory(skip bool) PublishOption

+ type PublishOptions struct

+ SkipHistory bool

+ type PublishResponse struct

+ Error *Error

+ Result *PublishResult

+ type PublishResult struct

+ Epoch string

+ Offset uint64

+ type Reply struct

+ Error *Error

+ Result json.RawMessage

+ type StreamPosition struct

+ Epoch string

+ Offset uint64

+ type SubscribeOption func(*SubscribeOptions)

+ func WithJoinLeave(enabled bool) SubscribeOption

+ func WithPosition(enabled bool) SubscribeOption

+ func WithPresence(enabled bool) SubscribeOption

+ func WithRecover(enabled bool) SubscribeOption

+ func WithRecoverSince(since *StreamPosition) SubscribeOption

+ func WithSubscribeClient(clientID string) SubscribeOption

+ func WithSubscribeData(data json.RawMessage) SubscribeOption

+ func WithSubscribeInfo(chanInfo json.RawMessage) SubscribeOption

+ type SubscribeOptions struct

+ ClientID string

+ Data json.RawMessage

+ Info json.RawMessage

+ JoinLeave bool

+ Position bool

+ Presence bool

+ Recover bool

+ RecoverSince *StreamPosition

+ type UnsubscribeOption func(options *UnsubscribeOptions)

+ func WithUnsubscribeClient(clientID string) UnsubscribeOption

+ type UnsubscribeOptions struct

+ ClientID string

Other modules containing this package

github.com/centrifugal/gocent

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL