README
¶
socket
| 
| |
A service that allows you to broadcast Publish and Listen messages to/from the server.
If i miss something or you have something interesting, please be part of this project. Let me know! My contact is at the end.
How it works ?
Flow example:
- CLIENT: creates a gateway server
- CLIENT: subscribe a topic/channel on the server
- SERVER: register the client on the topic/channel with the gateway to call it back later
- CLIENT: send a message to a topic/channel
- SERVER: receives the message and broadcast the message to all registered clients
- CLIENT: all clients receive the message sent
- CLIENT: unsubscribe the topic/channel on the server
Usage
This examples are available in the project at socket/examples
Server
func main() {
// server
server, err := socket.NewServer()
if err != nil {
panic(err)
}
if err := server.Start(); err != nil {
panic(err)
}
}
Client
func main() {
client, err := socket.NewClient()
if err != nil {
panic(err)
}
if err := client.Start(); err != nil {
panic(err)
}
if err := client.Subscribe("topic_1", "channel_1"); err != nil {
panic(err)
}
client.Listen("topic_1", "channel_1", func(message []byte) error {
fmt.Printf("\nreceived on listener the message %s", string(message))
return nil
})
if err := client.Publish("topic_1", "channel_1", []byte("hello, this is a test message")); err != nil {
panic(err)
}
// Unsubscribe
//if err := client.Unsubscribe("topic_1", "channel_1"); err != nil {
// panic(err)
//}
client.Wait()
}
Dependecy Management
Dependency
Project dependencies are managed using Dep. Read more about Dep.
- Get dependency manager:
go get github.com/joaosoft/dependency - Install dependencies:
dependency get
Go
go get github.com/joaosoft/socket
Known issues
Follow me at
Facebook: https://www.facebook.com/joaosoft
LinkedIn: https://www.linkedin.com/in/jo%C3%A3o-ribeiro-b2775438/
If you have something to add, please let me know joaosoft@gmail.com
Documentation
¶
Index ¶
- Constants
- func EncodeString(s string) string
- func Exists(file string) bool
- func GetEnv() string
- func ReadFile(file string, obj interface{}) ([]byte, error)
- func ReadFileLines(file string) ([]string, error)
- func WriteFile(file string, obj interface{}) error
- type AppConfig
- type Client
- func (c *Client) Config() *ClientConfig
- func (c *Client) Forget(topic, channel string, handler MessageHandler)
- func (c *Client) Listen(topic, channel string, handler MessageHandler)
- func (c *Client) Publish(topic, channel string, message []byte) error
- func (c *Client) Reconfigure(options ...SocketClientOption)
- func (c *Client) Start(waitGroup ...*sync.WaitGroup) error
- func (c *Client) Started() bool
- func (c *Client) Stop(waitGroup ...*sync.WaitGroup) error
- func (c *Client) Subscribe(topic, channel string) error
- func (c *Client) Unsubscribe(topic, channel string) error
- func (c *Client) Wait()
- type ClientConfig
- type MessageHandler
- type Server
- type ServerConfig
- type SocketClientOption
- type SocketConfig
- type SocketServerOption
Constants ¶
View Source
const (
HeaderGatewayKey = "Gateway"
)
Variables ¶
This section is empty.
Functions ¶
func EncodeString ¶
func ReadFileLines ¶
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) Config ¶
func (c *Client) Config() *ClientConfig
func (*Client) Forget ¶
func (c *Client) Forget(topic, channel string, handler MessageHandler)
Forget ...
func (*Client) Listen ¶
func (c *Client) Listen(topic, channel string, handler MessageHandler)
Listen ...
func (*Client) Reconfigure ¶
func (c *Client) Reconfigure(options ...SocketClientOption)
Reconfigure ...
func (*Client) Unsubscribe ¶
Unsubscribe ...
type ClientConfig ¶
type ClientConfig struct {
ServerAddress string `json:"server_address"`
*web.ClientConfig
}
ClientConfig ...
type MessageHandler ¶
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
func (*Server) Config ¶
func (s *Server) Config() *ServerConfig
func (*Server) Reconfigure ¶
func (s *Server) Reconfigure(options ...SocketServerOption)
Reconfigure ...
type SocketClientOption ¶
type SocketClientOption func(client *Client)
SocketClientOption ...
func WithClientConfiguration ¶
func WithClientConfiguration(config *ClientConfig) SocketClientOption
WithClientConfiguration ...
func WithClientLogLevel ¶
func WithClientLogLevel(level logger.Level) SocketClientOption
WithClientLogLevel ...
func WithClientLogger ¶
func WithClientLogger(logger logger.ILogger) SocketClientOption
WithClientLogger ...
func WithClientManager ¶
func WithClientManager(mgr *manager.Manager) SocketClientOption
WithClientManager ...
type SocketConfig ¶
type SocketConfig struct {
Server *ServerConfig `json:"server"`
Client *ClientConfig `json:"client"`
}
SocketConfig ...
type SocketServerOption ¶
type SocketServerOption func(server *Server)
SocketServerOption ...
func WithServerConfiguration ¶
func WithServerConfiguration(config *ServerConfig) SocketServerOption
WithServerConfiguration ...
func WithServerLogLevel ¶
func WithServerLogLevel(level logger.Level) SocketServerOption
WithServerLogLevel ...
func WithServerLogger ¶
func WithServerLogger(logger logger.ILogger) SocketServerOption
WithServerLogger ...
func WithServerManager ¶
func WithServerManager(mgr *manager.Manager) SocketServerOption
WithServerManager ...
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.