hooks.go

/*
 * Copyright 2021 CloudWeGo Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package server

import "sync"

// RegisterStartHook add hook which is executed after the server starts.
func RegisterStartHook(h func()) {
	muStartHooks.Lock()
	defer muStartHooks.Unlock()
	onServerStart.add(h)
}

// RegisterShutdownHook add hook which is executed after the server shutdown.
func RegisterShutdownHook(h func()) {
	muShutdownHooks.Lock()
	defer muShutdownHooks.Unlock()
	onShutdown.add(h)
}

// Hooks is a collection of func.
type Hooks []func()

// Add adds a hook.
func (h *Hooks) add(g func()) {
	*h = append(*h, g)
}

// Server hooks
var (
	onServerStart   Hooks      // Hooks executes after the server starts.
	muStartHooks    sync.Mutex // onServerStart 's mutex
	onShutdown      Hooks      // Hooks executes when the server is shutdown gracefully.
	muShutdownHooks sync.Mutex // onShutdown 's mutex
)