These examples should provide insight on how to use the golem framework.

After cloning the repository, simply run an example:

go run example_name.go

And access the example through your browser of choice, that supports WebSocket:

http://127.0.0.1:8080/example_name.html

To run the session example gorilla/sessions needs to be available in your GOPATH, so go get it first.

To run the custom protocol example v2/mgo/bson needs to be available in your GOPATH, so go get it first.

Some examples require the user to open the browser's console to see the output of the example.

Most of the provided examples are part of a tutorial from golem's wiki:

• Getting started
• Using rooms
• Building a Chat application
• Handshake authorisation using Sessions
• Using flash as WebSocket fallback
• Custom protocol using BSON
• Using an extended connection type

The simple example presents the most common and useful patterns provided by golem by default for simple communication.

This is a very simple example illustrating several ways to accept data. It shows how using an interface{} the raw interstage product of a protocol can be directly forwarded to the callback function and how the protocol can be extended for certain types (i.e. strings) along with simple communication patterns.

A single room is used to show off the general features of rooms. For a better demonstration multiple browser-tabs should be opened.

A very basic chat application allowing the user to join or leave rooms and broadcast messages to them.

Advanced example showing how handshake verfication can be used to only allow upgrading of connections with a valid session and authentication. The user has a login and logout button to change the session state and see the result.

This example illustrates how to use flash sockets as a fallback for WebSockets and how to handle the flash policy file. Needs to be run as root, because flash policy socket is <= 1024.

The protocol example presents how to implement custom protocols. In this case a custom BSON-based protocol is used to communicate between client and server.

Based on the simple example, but enhancing it to use a connection extension. Demonstrating additional methods and members of an extended connection.