README.md

🏬 Server, Client Framework - NWServerBaseFramework

서버, 클라이언트 개발을 EventListener 기반으로 쉽고 빠르게 개발 할 수있도록 만들어진 golang socket framework 입니다.

💻 How to use server framework?

package main

import (
    "fmt"
    "sync"

    "github.com/InoFlexin/serverbase/base"
)

type MyMessage base.Message

func (m MyMessage) OnMessageReceive(message *base.Message, client net.Conn) {
	fmt.Println("receive: " + message.Json + " key: " + message.Key)

	packetMessage := base.Message{Json: "pong", Key: base.GetServerKey(), Action: base.ON_MSG_RECEIVE}
	base.Write(&packetMessage, client)
}

func (m MyMessage) OnConnect(message *base.Message, client net.Conn) {
	fmt.Println("on connect: "+message.Json+" action: %d", message.Action)
}

func (m MyMessage) OnClose(err error) {
	log.Println(err)
}

func main() {
	wg := sync.WaitGroup{} 

	ev := MyMessage{} // 서버 이벤트 선언
	boot := base.Boot{Protocol: "tcp",
                      Port: ":5092",
                      ServerName: "test_server",
                      Callback: ev,
                      ReceiveSize: 
                      Complex: false}
	// server boot option 설정

	wg.Add(1) // synchronized gorutine
	go base.ServerStart(boot, &wg)
	wg.Wait()
}

💻 How to use client framework?

package main

import (
	"fmt"
	"sync"

	"github.com/InoFlexin/serverbase/base"
	"github.com/InoFlexin/serverbase/client"
)

type MyClientMessage base.Message //Client Message 타입 정의

// =================== Client Event Listeners ======================
func (m MyMessage) OnMessageReceive(message *base.Message, client net.Conn) {
	fmt.Println("on message receive: "+message.Json+" action: %d", message.Action)

	base.Write(&base.Message{Json: "pong", Action: base.ON_MSG_RECEIVE}, client)
}

func (m MyMessage) OnConnect(message *base.Message, client net.Conn) {
	fmt.Println("on connect: "+message.Json+" action: %d", message.Action)
}

func (m MyMessage) OnClose(err error) {
	log.Println(err)
}
// ==================================================================

func main() {
    wg := sync.WaitGroup{}

    event := MyClientMessage{}
    clientBoot := client.ClientBoot{Protocol: "tcp",
                                    HostAddr: "localhost",
                                    HostPort: ":5092",
                                    Callback: event, 
                                    BufferSize: 1024
                                    Complex: true}		
    wg.Add(1) // synchronized goroutine
    go client.ConnectServer(&clientBoot, &wg)
    wg.Wait()

    /*
        해당 프레임워크에서는 클라이언트의 테스트를 위한 SendPing 함수가 존재한다.
    */
    serverError := client.SendPing(time.Second * 2)
    
    if serverError != nil {
            log.Fatal(serverError)
    }
}

📂 Updates

• v1.0.1
  • Server/Client Socket Option 구조체
  • EventListener interface 정의
  • 예제 작성
  • Server/Client Logic 정의
  • goroutine sync 지원
  • session 지원
• v1.0.2
  • Json 기반 통신 지원
• v1.0.3
  • Boot구조체에 복합서버 지원여부 추가
  • OnClose 콜백 함수로 오는 인자값을 Message에서 error로 변경
  • 서버 코드 내부 로직 수정
• v1.0.4
  • 각 프록시간 식별자를 추가 base.Message.Key로 사용가능
  • Session 구현 책임을 자식 모듈로 넘김
  • SocketMessage 추가
  • session.go에서 연결된 모듈들 키 조회 가능 (세션 구현은 자식모듈에서 해야함)

🙋‍ 개발자

남대영 - wsnam0507@gmail.com