https://github.com/mstoykov/gomahawk

WIP implementation of the tomahawk api in go
https://github.com/mstoykov/gomahawk

Last synced: 7 months ago
JSON representation

WIP implementation of the tomahawk api in go

Host: GitHub
URL: https://github.com/mstoykov/gomahawk
Owner: mstoykov
License: mit
Created: 2013-12-09T11:15:59.000Z (about 12 years ago)
Default Branch: master
Last Pushed: 2014-02-15T11:31:37.000Z (almost 12 years ago)
Last Synced: 2024-12-25T13:42:02.057Z (12 months ago)
Language: Go
Size: 328 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

gomahawk
========

WIP implementation of the [Network Protocol of tomahawk](http://wiki.tomahawk-player.org/index.php/Network_Protocol) in golang

Install
=======

go get github.com/MStoykov/gomahawk

Features
========

Done
----

* Advertising the instance
* Incoming connections
* Request for DBConnection
* Request for StreamConnection
* All the Documented dbsync commands
* DBsync from us to the opposite side

Planned
-------

* Listen for advertising
* Making ControlConnections
* Reverse Connections (Requests for connections and Answering Requests)
* Answering DBConnection requests
* Answering StreamConnections
* Basic implementations for some parts needed for the client of gomahawk
* InMemory searchable database for remote instances
* etc.
* Implementing the nondocumented dbsync commands

Usage
=====

Import
------

import (
"github.com/MStoykov/gomahawk"
)

Implement Tomahawk Interface
----------------------------

look at [examples](./examples/) for more examples of how to use the api

Make new Gomahawk instance
--------------------------

g := NewGomahawkImpl()
gs := gomahawk.NewGomahawkServer(g)
err := gs.ListenTo(net.ParseIP("192.168.1.13"), "50210") // Listen on 192.168.1.13 and the default tomahawk port
// error checking
gs.Start()

Requesting DBConnection
-----------------------
This is used to get the changes from the remote

var gs GomahawkServer
t := gs.Tomahawks()[0] // get the first of the connected Tomahawks
err := t.RequestDBConnection(dbConnectionImpl) // the dbConnectionImpl is the implemenation of the DBConnection
// error handleing
// the Gomahawk registered with the GomahawkServer gs will get call to
// NewDBConnection with the Tomahawk instance and the given DBConnection can be used to initializa fetching
dbConnection.FetchOps(fetchOps, "") // get all changes
// the methods on fetchOps will be called in order and at the end the Close() method will be called
// that signals that all current changes have been transmitted

LICENSE
=======
The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/mstoykov/gomahawk

Awesome Lists containing this project

README