Aucuba

     ___      __    __    ______  __    __  .______        ___      
    /   \    |  |  |  |  /      ||  |  |  | |   _  \      /   \     
   /  ^  \   |  |  |  | |  ,----'|  |  |  | |  |_)  |    /  ^  \    
  /  /_\  \  |  |  |  | |  |     |  |  |  | |   _  <    /  /_\  \   
 /  _____  \ |  `--'  | |  `----.|  `--'  | |  |_)  |  /  _____  \  
/__/     \__\ \______/   \______| \______/  |______/  /__/     \__\ 
                                                                    

Aucuba is a concise and lightweight socket framework

Overall structure

Install

go get github.com/JontyX/Aucuba

QuickStart

Server

Based on the server application developed by the Aucuba framework, the main function steps are relatively simple and only need 4 steps at most.

• Create server handle
• Register hook function
• Configure custom routing and services
• Start service

func main() {
	// create server handle
	s := Aucuba.NewServer()
	
    // Configure hook function
    s.SetOnConnStart(DoConnectionBegin)
	s.SetOnConnStop(DoConnectionLost)

	// Configure custom routing and services
	s.AddRouter(1, &HelloAucubaRouter{})

	// start service
	s.Serve()
}

Custom routing and hook configuration methods：

import (
	"fmt"
	"github.com/JontyX/Aucuba"
	"github.com/JontyX/Aucuba/aiface"
)

type HelloAucubaRouter struct {
	Aucuba.BaseRouter
}

//HelloAucubaRouter Handle
func (this *HelloAucubaRouter) Handle(request aiface.IRequest) {
	fmt.Println("Call HelloAucubaRouter Handle")
	fmt.Println("recv from client : msgId=", request.GetMsgId(), ", data=", string(request.GetData()))
	err := request.GetConnection().SendBuffMsg(1, []byte("Hello Aucuba Router V1.0"))
	if err != nil {
		fmt.Println(err)
	}
}

//Execute when the connection is created
func DoConnectionBegin(conn aiface.IConnection) {
	fmt.Println("DoConnecionBegin is Called ... ")
	err := conn.SendMsg(2, []byte("DoConnection BEGIN..."))
	if err != nil {
		fmt.Println(err)
	}
}

//Execute when the connection is disconnected
func DoConnectionLost(conn aiface.IConnection) {
	//Before the connection is destroyed, query the Name and Home properties of conn
	if name, err := conn.GetProperty("Name"); err == nil {
		fmt.Println("Conn Property Name = ", name)
	}
	if home, err := conn.GetProperty("Home"); err == nil {
		fmt.Println("Conn Property Home = ", home)
	}
	fmt.Println("DoConnection is called")
}

client

message processing uses the packet format of [MsgLength]|[MsgID]|[Data]

import (
	"fmt"
	"github.com/JontyX/Aucuba"
	"io"
	"net"
	"time"
)

/*
   simulate client
*/
func main() {
	fmt.Println("Client Test ... start")
	time.Sleep(3 * time.Second)
	conn, err := net.Dial("tcp", "127.0.0.1:8999")
	if err != nil {
		fmt.Println("client start err, exit!")
		return
	}
	for {
		//Send packet message
		dp := Aucuba.NewDataPack()
		msg, _ := dp.Pack(Aucuba.NewMsgPackage(0, []byte("Aucuba Client0 Test Message")))
		_, err := conn.Write(msg)
		if err != nil {
			fmt.Println("write error err ", err)
			return
		}
		//Read the head part of the stream first
		headData := make([]byte, dp.GetHeadLen())
		_, err = io.ReadFull(conn, headData)
		if err != nil {
			fmt.Println("read head error")
			break
		}
		//Unpack the headData byte stream into msg
		msgHead, err := dp.Unpack(headData)
		if err != nil {
			fmt.Println("server unpack err:", err)
			return
		}
		if msgHead.GetMsgLen() > 0 {
			msg := msgHead.(*Aucuba.Message)
			msg.Data = make([]byte, msg.GetMsgLen())
			//Read byte stream from io according to dataLen
			_, err := io.ReadFull(conn, msg.Data)
			if err != nil {
				fmt.Println("server unpack data err:", err)
				return
			}
			fmt.Println("==> Recv Msg: ID=", msg.Id, ", len=", msg.DataLen, ", data=", string(msg.Data))
		}
		time.Sleep(1 * time.Second)
	}
}