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
- API
  
  Reference documentation for the pkg.go.dev API
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

centrifuge

package module

Go to main page

Versions in this module

v0

v0.2.0

Oct 7, 2018

Changes in this version

type Client

+ func (c *Client) NewSubscription(channel string) (*Subscription, error)

+ func (c *Client) OnConnect(handler ConnectHandler)

+ func (c *Client) OnDisconnect(handler DisconnectHandler)

+ func (c *Client) OnError(handler ErrorHandler)

+ func (c *Client) OnMessage(handler MessageHandler)

+ func (c *Client) OnPrivateSub(handler PrivateSubHandler)

+ func (c *Client) OnRefresh(handler RefreshHandler)

type Subscription

+ func (s *Subscription) OnJoin(handler JoinHandler)

+ func (s *Subscription) OnLeave(handler LeaveHandler)

+ func (s *Subscription) OnPublish(handler PublishHandler)

+ func (s *Subscription) OnSubscribeError(handler SubscribeErrorHandler)

+ func (s *Subscription) OnSubscribeSuccess(handler SubscribeSuccessHandler)

+ func (s *Subscription) OnUnsubscribe(handler UnsubscribeHandler)

v0.1.0

Sep 17, 2018

Changes in this version

+ const CLOSED

+ const CONNECTED

+ const CONNECTING

+ const DISCONNECTED

+ const DefaultPingInterval

+ const DefaultPrivateChannelPrefix

+ const DefaultReadTimeout

+ const DefaultWriteTimeout

+ const NEW

+ const SUBERROR

+ const SUBSCRIBED

+ const SUBSCRIBING

+ const UNSUBSCRIBED

+ var ErrClientClosed = errors.New("client closed")

+ var ErrClientDisconnected = errors.New("client disconnected")

+ var ErrClientExpired = errors.New("client connection expired")

+ var ErrDuplicateSubscription = errors.New("duplicate subscription")

+ var ErrReconnectFailed = errors.New("reconnect failed")

+ var ErrTimeout = errors.New("timeout")

+ type Client struct

+ func New(u string, events *EventHub, config Config) *Client

+ func (c *Client) Close() error

+ func (c *Client) Connect() error

+ func (c *Client) Disconnect() error

+ func (c *Client) Publish(channel string, data []byte) error

+ func (c *Client) RPC(data []byte) ([]byte, error)

+ func (c *Client) Send(data []byte) error

+ func (c *Client) SetConnectData(data proto.Raw)

+ func (c *Client) SetHeader(key, value string)

+ func (c *Client) SetToken(token string)

+ func (c *Client) Subscribe(channel string, events *SubscriptionEventHub) (*Subscription, error)

+ func (c *Client) SubscribeSync(channel string, events *SubscriptionEventHub) (*Subscription, error)

+ type ClientInfo = proto.ClientInfo

+ type Config struct

+ CookieJar http.CookieJar

+ EnableCompression bool

+ HandshakeTimeout time.Duration

+ Header http.Header

+ PingInterval time.Duration

+ PrivateChannelPrefix string

+ ReadTimeout time.Duration

+ TLSConfig *tls.Config

+ WriteTimeout time.Duration

+ func DefaultConfig() Config

+ type ConnectEvent struct

+ ClientID string

+ Data []byte

+ Version string

+ type ConnectHandler interface

+ OnConnect func(*Client, ConnectEvent)

+ type DisconnectEvent struct

+ Reason string

+ Reconnect bool

+ type DisconnectHandler interface

+ OnDisconnect func(*Client, DisconnectEvent)

+ type Error = proto.Error

+ type ErrorEvent struct

+ Message string

+ type ErrorHandler interface

+ OnError func(*Client, ErrorEvent)

+ type EventHub struct

+ func NewEventHub() *EventHub

+ func (h *EventHub) OnConnect(handler ConnectHandler)

+ func (h *EventHub) OnDisconnect(handler DisconnectHandler)

+ func (h *EventHub) OnError(handler ErrorHandler)

+ func (h *EventHub) OnMessage(handler MessageHandler)

+ func (h *EventHub) OnPrivateSub(handler PrivateSubHandler)

+ func (h *EventHub) OnRefresh(handler RefreshHandler)

+ type JoinEvent struct

+ type JoinHandler interface

+ OnJoin func(*Subscription, JoinEvent)

+ type LeaveEvent struct

+ type LeaveHandler interface

+ OnLeave func(*Subscription, LeaveEvent)

+ type MessageEvent struct

+ Data []byte

+ type MessageHandler interface

+ OnMessage func(*Client, MessageEvent)

+ type PresenceStats struct

+ NumClients int

+ NumUsers int

+ type PrivateSubEvent struct

+ Channel string

+ ClientID string

+ type PrivateSubHandler interface

+ OnPrivateSub func(*Client, PrivateSubEvent) (string, error)

+ type Publication = proto.Publication

+ type PublishEvent struct

+ type PublishHandler interface

+ OnPublish func(*Subscription, PublishEvent)

+ type RefreshHandler interface

+ OnRefresh func(*Client) (string, error)

+ type SubscribeErrorEvent struct

+ Error string

+ type SubscribeErrorHandler interface

+ OnSubscribeError func(*Subscription, SubscribeErrorEvent)

+ type SubscribeSuccessEvent struct

+ Recovered bool

+ Resubscribed bool

+ type SubscribeSuccessHandler interface

+ OnSubscribeSuccess func(*Subscription, SubscribeSuccessEvent)

+ type Subscription struct

+ func (s *Subscription) Channel() string

+ func (s *Subscription) History() ([]Publication, error)

+ func (s *Subscription) Presence() (map[string]ClientInfo, error)

+ func (s *Subscription) PresenceStats() (PresenceStats, error)

+ func (s *Subscription) Publish(data []byte) error

+ func (s *Subscription) Status() int

+ func (s *Subscription) Subscribe() error

+ func (s *Subscription) Unsubscribe() error

+ type SubscriptionEventHub struct

+ func NewSubscriptionEventHub() *SubscriptionEventHub

+ func (h *SubscriptionEventHub) OnJoin(handler JoinHandler)

+ func (h *SubscriptionEventHub) OnLeave(handler LeaveHandler)

+ func (h *SubscriptionEventHub) OnPublish(handler PublishHandler)

+ func (h *SubscriptionEventHub) OnSubscribeError(handler SubscribeErrorHandler)

+ func (h *SubscriptionEventHub) OnSubscribeSuccess(handler SubscribeSuccessHandler)

+ func (h *SubscriptionEventHub) OnUnsubscribe(handler UnsubscribeHandler)

+ type UnsubscribeEvent struct

+ type UnsubscribeHandler interface

+ OnUnsubscribe func(*Subscription, UnsubscribeEvent)

v0.0.1

Sep 11, 2018