Hawk

A toolkit that provides service building, startup and other functions.

Our product:

Here are the main features.

• TSMM
• broker
• config
• status
• trace
• middleware
• register
• consul

Getting Started

Installation

Run the following command under your project

go get -u github.com/tyr-tech-team/hawk

TSMM

Tyr Schedule Master Manager!

Client

You can new a Client with a Broker.

import(
  "context"
  "time"

  "github.com/tyr-tech-team/hawk/broker"
  "github.com/tyr-tech-team/hawk/broker/natsstreaming"
  tsmm_client "github.com/tyr-tech-team/hawk/tsmm/client"
)

// New nats streaming Broker
broker := broker.NewBroker(natsstreaming.New())

// New Tsmm Client
client := tsmm_client.NewTsmmClient(broker)

In the client, you can send add, update, cancel schedule request like this.
Because Tsmm uses an asynchronous transfer, you will not receive a response immediately.

// Add schedule
client.AddSchedule(context.Background(), &tsmm_client.AddScheduleReq{})

// Update schedule
client.UpdateSchedule(context.Background(), &tsmm_client.UpdateScheduleReq{})

// Cancel schedule
client.CancelSchedule(context.Background(), &tsmm_client.CancelScheduleReq{})

Server

New a Server with the Broker.

import(
  "context"
  "time"

  "github.com/tyr-tech-team/hawk/broker"
  "github.com/tyr-tech-team/hawk/broker/natsstreaming"
  tsmm_server "github.com/tyr-tech-team/hawk/tsmm/server"
)

// New nats streaming Broker
broker := broker.NewBroker(natsstreaming.New())

// New Tsmm Server
server := tsmm_server.NewTsmmServer(broker)

There is an option you can change the queue group name. If it is empty or you don't use this option, it will be tsmm.

server := tsmm_server.NewTsmmServer(
  broker,
  tsmm_server.SetQueueName("my-queue-name"),
)

Use Server to subscribe the topic you want to listen or existing add, delete, update reply. You need to give an closure func to make sure you can run somthing when Tsmm receive response.

⚠️ Make sure the thread these subscribe function stay in should not be stopped.

// subscribe add schedule reply
a.tsmmServer.AddScheduleReply(
  func(header map[string]interface{}, res *tsmm_server.AddScheduleRes) error {
    // ...somthing...
    return nil
  },
)

// subscribe update schedule reply
a.tsmmServer.UpdateScheduleReply(
  func(header map[string]interface{}, res *tsmm_server.UpdateScheduleRes) error {
    // ...somthing...
    return nil
  },
)

// subscribe cancel schedule reply
a.tsmmServer.CancelScheduleReply(
  func(header map[string]interface{}, res *tsmm_server.CancelScheduleRes) error {
    // ...somthing...
    return nil
  },
)

// subscribe a customized topic
a.tsmmServer.AddTopic(
  "my-topic",
  func(header map[string]interface{}, res []byte) error {
    // ...somthing...
    return nil
  },
)

broker

A broker is an intermediary entity that enables message queue clients to communicate. The pub/sub model is at the core of broker communication. Information is organized by topics. client devices can publish data to a topic to send messages to any subscribers. Similarly, clients can subscribe to a topic to be notified when a message is published.

Client

You can new a Client with a Broker

broker.NewBroker()

However, the broker is an interface, you must implement a struct. so the boker provider quickly starts nata and nat-streaming functions.

Basic Usage

import(
  "github.com/tyr-tech-team/hawk/broker/natsstreaming"
  "github.com/tyr-tech-team/hawk/broker/nats"
)

func main() {
    // new nats 
    n := nats.NewNats()
    bn :=  broker.NewBroker(n)
    
    // new natsstreaming 
    ns := natsstreaming.New()
    bns := broker.NewBroker(ns)
}

Sub / Pub

import(
  "github.com/tyr-tech-team/hawk/broker/natsstreaming"
  "github.com/tyr-tech-team/hawk/broker/nats"
)

func main() {
    b :=  broker.NewBroker(nats.NewNats())
    
    // Subscribe "topic" channel
    subscribe, err := b.Subscribe("topic", func(e broker.Event) error {
        // get data
        data := e.Message().Body
        // do something...
    })
    
    // Subscribe "topic" channel and tyr group
    subscribe, err = b.Subscribe("topic", func(e broker.Event) error {
        // do something...
    }, broker.Queue("tyr"))
    
    
    // Publish message to topic channel
    err = b.Publish("topic", &broker.Message{
        Header: map[string]interface{}{},
        Body: []byte("tyr"),   
    })
    
    // Unsubscribe
    subscribe.Unsubscribe()
    
    // disconnect broker
    b.Disconnect()
}

config

status

trace

middleware

env

service

register

consul