https://github.com/ambelovsky/gosf

Go SocketIO API Framework
https://github.com/ambelovsky/gosf

framework go golang socket-io socket-io-server

Last synced: 2 months ago
JSON representation

Go SocketIO API Framework

• Host: GitHub
• URL: https://github.com/ambelovsky/gosf
• Owner: ambelovsky
• License: mit
• Created: 2019-04-26T00:59:18.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-11-09T20:13:45.000Z (about 4 years ago)
• Last Synced: 2024-10-16T07:21:25.011Z (3 months ago)
• Topics: framework, go, golang, socket-io, socket-io-server
• Language: Go
• Homepage: http://gosf.io
• Size: 43.9 KB
• Stars: 98
• Watchers: 6
• Forks: 14
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Go Socket.IO Framework (GOSF)

Go Socket.IO Framework or GOSF is an easy-to-use framework for developing Socket.IO API's in Google's Go language (GoLang).

Support ongoing development efforts with a transfer to BTC wallet 13pkXi8bW5bKjWewQYtv36CUgwhgQEn7eA

**Supports Socket.IO Version 2**

An example server to help you get started can be found at [github.com/ambelovsky/gosf-sample-app](https://github.com/ambelovsky/gosf-sample-app).

For an in-depth look at the API Framework, check us out at [gosf.io](http://gosf.io).

## Get It

```sh

go get -u "github.com/ambelovsky/gosf"

```

## Features

* Socket.IO v2 Support

* Request/Response Acknowledgement-Based Cycle

* Broadcast/Room Support

* Microservices Using Socket.IO

* Plugable Architecture

* App, Client, and Request Contexts

* Standardized Message Format

## Quick Start

The following sample will start a server that responds on an "echo" endpoint and return the same message received from the client back to the client.

### Server

```go

package main

import (

  f "github.com/ambelovsky/gosf"

)

func init() {

  // Listen on an endpoint

  f.Listen("echo", func(client *f.Client, request *f.Request) *f.Message {

    return f.NewSuccessMessage(request.Message.Text)

  })

}

func main() {

  // Start the server using a basic configuration

  f.Startup(map[string]interface{}{

    "port": 9999})

}

```

### Client

```html

  var socket = io.connect('ws://localhost:9999', { transports: ['websocket'] });

  socket.emit('echo', { text: 'Hello world.' }, function(response) {

    console.log(response);

  });

```

## Learn More

Discover more about GOSF with the complete documentation at [gosf.io](http://gosf.io).

## Documenting Your API

While you're building your API, take some time to build the documentation too!  Check out [github.com/ambelovsky/go-api-docs](https://github.com/ambelovsky/go-api-docs) for an

easy-to-use documentation system built using the slate theme.

## Original Author

[Aaron Belovsky](https://github.com/ambelovsky) is a senior technologist, avid open source contributor, and author of GOSF.

## License

MIT