README
¶
NyuSocket
go get github.com/Nyura95/nyusocket
Next step of development
- Change the creation of events to make it more 'user frendly'
Basic usage
Sending Message
Server
package main
import "fmt"
import "os"
import "github.com/Nyura95/nyusocket"
import "context"
func main() {
events := socket.NewEvents()
defer events.Close()
events.CreateClientMessageEvent()
go socket.Start(context.Background(), socket.Options{Addr: "127.0.0.1:3000"})
for {
select {
case clientMessage := <-events.ClientMessage:
for _, other := range clientMessage.Client.GetOthersClients() {
other.Send(nyusocket.NewMessage("message", clientMessage.Message, "message").Send())
}
}
}
}
Event before a login user
package main
import "fmt"
import "os"
import "context"
import "github.com/Nyura95/nyusocket"
type storeClient struct {
token string
}
func main() {
events := nyusocket.NewEvents()
defer events.Close()
events.CreateClientMessageEvent()
events.CreateAuthorizationEvent()
go nyusocket.Start(context.Background(), events, nyusocket.Options{Addr: "127.0.0.1:3000"})
for {
select {
case authorization := <-events.Authorization:
// authorize only one 'token' (check the client for pass the query)
authorization.Client.Store = storeClient{
token: authorization.Client.Query["token"][0],
}
authorization.Client.Hash = authorization.Client.Query["token"][0]
authorization.Authorize <- !nyusocket.Infos.Alive(authorization.Client) // chan authorization.Authorize return an boolean, if false the client is unregister
case clientMessage := <-events.ClientMessage:
storeClient := clientMessage.Client.Store.(storeClient) // get store client
for _, other := range clientMessage.Client.GetOthersClients() { // get all other clients actually registered
other.Send(nyusocket.NewMessage("message", fmt.Sprintf("%s: %s", storeClient.token, clientMessage.Message), "message").Send()) // send customer's message to others
}
}
}
}
Event on the new client login
package main
import "fmt"
import "os"
import "context"
import "github.com/Nyura95/nyusocket"
func main() {
events := nyusocket.NewEvents()
defer events.Close()
events.CreateClientMessageEvent()
events.CreateRegisterEvent()
go nyusocket.Start(context.Background(), events, nyusocket.Options{Addr: "127.0.0.1:3000"})
for {
select {
case clientMessage := <-events.ClientMessage:
for _, other := range clientMessage.Client.GetOthersClients() {
other.Send(nyusocket.NewMessage("message", clientMessage.Message, "message").Send())
}
case client := <-events.Register: // new client registered
client.Send(nyusocket.NewMessage("register", "Hello there!", "new_register").Send()) // send a message to the client
for _, other := range client.GetOthersClients() {
other.Send(nyusocket.NewMessage("register", "New client", "new_register").Send()) // tell others that a new customer is registered
}
}
}
}
Event on the client logout
package main
import "fmt"
import "os"
import "context"
import "github.com/Nyura95/nyusocket"
func main() {
events := nyusocket.NewEvents()
defer events.Close()
events.CreateClientMessageEvent()
events.CreateUnregisterEvent()
go nyusocket.Start(context.Background(), events, nyusocket.Options{Addr: "127.0.0.1:3000"})
for {
select {
case clientMessage := <-events.ClientMessage:
for _, other := range clientMessage.Client.GetOthersClients() {
other.Send(nyusocket.NewMessage("message", clientMessage.Message, "message").Send())
}
case unregister := <-events.Unregister:
// unregister.Store (you can access to the store client if needed)
for _, other := range unregister.Hub.GetClients() {
other.Send(nyusocket.NewMessage("unregister", "Client unregister", "new_unregister").Send()) // tell others that a new customer is logout
}
}
}
}
Stop server
package main
import "fmt"
import "os"
import "time"
import "github.com/Nyura95/nyusocket"
import "context"
func main() {
events := nyusocket.NewEvents()
defer events.Close()
events.CreateClientMessageEvent()
ctx, cancel := context.WithCancel(context.Background())
go func() {
time.Sleep(5 * time.Second)
cancel()
}()
nyusocket.Start(ctx, nyusocket.Options{Addr: "127.0.0.1:3000"})
log.Println("server closed")
}
Client side
Message server example
{ Action: string, Message: string, Key: string, Created: Date }
Who to use ? (see client.html)
var states = {
[WebSocket.CONNECTING]: "CONNECTING",
[WebSocket.OPEN]: "OPEN",
[WebSocket.CLOSING]: "CLOSING",
[WebSocket.CLOSED]: "CLOSED",
};
var _messages = [];
var client = new WebSocket("ws://...");
client.onopen = function (event) {
console.log(event);
document.getElementById("state").innerHTML =
"state: " + states[client.readyState];
};
client.onmessage = function (msg) {
console.log("New message: ", msg);
var messages = msg.data.split("\n");
for (let i = 0; i < messages.length; i++) {
var message = messages[i];
try {
message = JSON.parse(message);
} catch (err) {
console.log(err);
}
_messages.push(message);
var tchat = document.getElementById("messages");
tchat.value = _messages
.map(function (x) {
return "Action: " + x.Action + " | " + x.Message;
})
.join("\r\n");
tchat.scrollTo({ top: tchat.scrollHeight });
}
};
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type BeforeUpgrade ¶
BeforeUpgrade ...
type Client ¶
type Client struct {
Store *Store
// contains filtered or unexported fields
}
Client is a middleman between the websocket connection and the hub.
func (*Client) GetOthersClients ¶
GetOthersClients ...
type Events ¶
type Events struct {
BeforeUpgrade chan BeforeUpgrade
Register chan *Client
Unregister chan Unregister
ClientMessage chan ClientMessage
}
Events ...
func (*Events) CreateBeforeUpgradeEvent ¶
func (e *Events) CreateBeforeUpgradeEvent()
CreateBeforeUpgradeEvent ...
func (*Events) CreateClientMessageEvent ¶
func (e *Events) CreateClientMessageEvent()
CreateClientMessageEvent ...
func (*Events) CreateUnregisterEvent ¶
func (e *Events) CreateUnregisterEvent()
CreateUnregisterEvent ...
type Hub ¶
type Hub struct {
// contains filtered or unexported fields
}
Hub of the clients
func (*Hub) GetClients ¶
GetClients return all clients connected
func (*Hub) SendToAllClients ¶
SendToAllClients ...
Source Files
Click to show internal directories.
Click to hide internal directories.