https://github.com/getlantern/serveme

Go library for client-server TCP communication in which the server dials the client
https://github.com/getlantern/serveme

Last synced: 9 months ago
JSON representation

Go library for client-server TCP communication in which the server dials the client

• Host: GitHub
• URL: https://github.com/getlantern/serveme
• Owner: getlantern
• Created: 2014-11-25T02:52:04.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2018-03-02T17:41:20.000Z (over 8 years ago)
• Last Synced: 2024-04-15T03:25:50.130Z (about 2 years ago)
• Language: Go
• Size: 10.7 KB
• Stars: 4
• Watchers: 14
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
serveme [![Travis CI Status](https://travis-ci.org/getlantern/serveme.svg?branch=master)](https://travis-ci.org/getlantern/serveme) [![Coverage Status](https://coveralls.io/repos/getlantern/serveme/badge.png)](https://coveralls.io/r/getlantern/serveme) [![GoDoc](https://godoc.org/github.com/getlantern/serveme?status.png)](http://godoc.org/github.com/getlantern/serveme)

==========

```golang

// package serveme implements a Dialer and a net.Listener that allow a client

// and server to communicate by having the server contact the client rather than

// the other way around. This is handy in situations where the client is

// reachable using an IP and port, but the server isn't (for example if the

// server is behind an impenetrable NAT).

//

// For this to work, the client and server must be able to communicate with each

// other via a signaling channel. When the client wants to connect to the

// server, it sends a message with the necessary connection information to the

// server, which then connects to the client.

//

// Right now, serveme only supports TCP.

```

To install:

`go get github.com/getlantern/serveme`

For docs:

`godoc github.com/getlantern/serveme`