HSServer Introduction

HSServer is golang RPC-like server framework, that'll allow you to create and manage high performance micro-services that can be accessed via high performance binary protocol, and using HTTP. Its purpose is to allow PHP developers to easily migrate algorithms that require persistent data or a lot of CPU power to golang.

Easy Deployment

Like 1,2,3...

1. Compile and run the server, all is pre-configured
2. Add single client file to your PHP app
3. Call golang code, get php struct back (using JSON)

<?php
include 'inc.hsclient.php';

$go = new HSClient();
$header_out = [];
$data = $go->sendDataJSON(['action'=>'echo', 'data'=>123], $header_out, 2);
print_r($data);

Features

• Slab memory allocator and buffer sharing to limit memory allocation and GC
• Complete solution, contains high performance client implementing binary protocol, and server
• Easy developement and deployment
• Built-in, configurable compression support
• Comprehensive statistics
• High performance and production-tested. Ability to serve 10-20k req/s per CPU core

Simple Run

./server

Production deployment with auto-restart

screen
cd ./go-worker/bin
started=\`date +%Y%m%d@%H:%M\`; for i in {1..999999}; do ./go-worker 1>/dev/null 2>"error-$started-$i.log.txt"; sleep 10; done;

If everything went ok you should be able to see server's status page: http://127.0.0.1:7778/?action=server-status

Configuration

Configuration needs to be stored in conf.json in the binary directory. By default, the server will listen on localhost. Connections can be made using built-in protocol on TCP and UDP port 7777, and also HTTP on port 7778.

{
"BIND_TO":"127.0.0.1:7777,u127.0.0.1:7777,h127.0.0.1:7778",
"FORCE_START":true,
"DEBUG":false,
"VERBOSE":false,
"RUN_SERVICES":"profiler,echo"
}

PHP Communication

You can communicate with the server easily by using both TCP and UDP.

<?php
include 'inc.hsclient.php';

define("HS_HOST", "127.0.0.1");
define("HS_PORT", "7777");

$go = new HSClient(HS_HOST, HS_PORT); // change to HSClientUDP to use UDP packets instead of TCP connection
$header_out = [];
$go_call = $go->sendDataJSON(['action'=>'echo', 'data'=>123], $header_out, 2);

print_r($go_call);
echo "<hr><h1>Header</h1>";
print_r($header);

You can also use do the same thing using HTTP by pointing your browser to

http://127.0.0.1:7778/?action=echo&data=123

Developing modules

Adding modules to server should be self-explanatory, please see /echo directory inside server sources to see example of simple module, later there'll be documentation added.

Each module needs to be registered afterwards (please see main server file)

package echo

import (
	"encoding/json"
	"github.com/slawomir-pryczek/HSServer/handler_socket2"
)

type HandleEcho struct {
}

func (this *HandleEcho) Initialize() {

	handler_socket2.StatusPluginRegister(func() (string, string) {
		return "Echo", "Echo plugin is enabled"
	})

}

func (this *HandleEcho) Info() string {
	return "This plugin will send back received data"
}

func (this *HandleEcho) GetActions() []string {
	return []string{"echo"}
}

func (this *HandleEcho) HandleAction(action string, data *handler_socket2.HSParams) string {

	ret := map[string]string{}
	ret["data"] = data.GetParam("data", "")
	_tmp, _ := json.Marshal(ret)

	return string(_tmp)
}