README
¶
Cluster
Allows communication and synchronization between cluster nodes
Install
To install the library
$ go get github.com/najibulloShapoatov/server-core/cluster
Usage example
c, err := cluster.Join("cluster-name")
// Listen for cluster messages
c.OnMessage(func(msg *cluster.Message) {
// handle message from other nodes
})
// send a message to all nodes in the cluster
c.Broadcast(message)
// Obtain a mutex lock in the cluster
err := c.Lock("lock-name")
if err != nil {
// Mutex is already lock by another node
}
// ...
// Perform action
// ...
// release lock
c.Unlock("lock-name")
// Leave the cluster
c.Leave()
Documentation
¶
Index ¶
- type Cluster
- type Message
- func (m Message) Bool() (res bool, err error)
- func (m Message) Float() (res float64, err error)
- func (m Message) Int() (res int, err error)
- func (m Message) MarshalBinary() (data []byte, err error)
- func (m Message) String() (res string, err error)
- func (m *Message) UnmarshalBinary(data []byte) error
- func (m Message) Unpack(ptr interface{}) (err error)
- type MessageHandler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Cluster ¶
type Cluster struct {
// contains filtered or unexported fields
}
func (*Cluster) OnMessage ¶
func (c *Cluster) OnMessage(callback MessageHandler)
Register a callback to handle cluster messages
type Message ¶
type Message struct {
Type messageType `json:"type"`
NodeID int `json:"nodeID"`
Data json.RawMessage `json:"data"`
}
func (Message) MarshalBinary ¶
func (*Message) UnmarshalBinary ¶
type MessageHandler ¶
type MessageHandler func(*Message)
Source Files
Click to show internal directories.
Click to hide internal directories.