common_options.go

// Copyright 2023-2024 antlabs. All rights reserved.
//
// 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 greatws

import (
	"time"
	"unicode/utf8"
)

// 0. CallbackFunc
func WithClientCallbackFunc(open OnOpenFunc, m OnMessageFunc, c OnCloseFunc) ClientOption {
	return func(o *DialOption) {
		o.cb = &funcToCallback{
			onOpen:    open,
			onMessage: m,
			onClose:   c,
		}
	}
}

// 配置服务端回调函数
func WithServerCallbackFunc(open OnOpenFunc, m OnMessageFunc, c OnCloseFunc) ServerOption {
	return func(o *ConnOption) {
		o.cb = &funcToCallback{
			onOpen:    open,
			onMessage: m,
			onClose:   c,
		}
	}
}

// 1. callback
// 配置客户端callback
func WithClientCallback(cb Callback) ClientOption {
	return func(o *DialOption) {
		o.cb = cb
	}
}

// 配置服务端回调函数
func WithServerCallback(cb Callback) ServerOption {
	return func(o *ConnOption) {
		o.cb = cb
	}
}

// 2. 设置TCP_NODELAY
// 设置客户端TCP_NODELAY
func WithClientTCPDelay() ClientOption {
	return func(o *DialOption) {
		o.tcpNoDelay = false
	}
}

// 设置TCP_NODELAY 为false, 开启nagle算法
// 设置服务端TCP_NODELAY
func WithServerTCPDelay() ServerOption {
	return func(o *ConnOption) {
		o.tcpNoDelay = false
	}
}

// 3.关闭utf8检查
func WithServerEnableUTF8Check() ServerOption {
	return func(o *ConnOption) {
		o.utf8Check = utf8.Valid
	}
}

func WithClientEnableUTF8Check() ClientOption {
	return func(o *DialOption) {
		o.utf8Check = utf8.Valid
	}
}

// 4.仅仅配置OnMessae函数
// 仅仅配置OnMessae函数
func WithServerOnMessageFunc(cb OnMessageFunc) ServerOption {
	return func(o *ConnOption) {
		o.cb = OnMessageFunc(cb)
	}
}

// 仅仅配置OnMessae函数
func WithClientOnMessageFunc(cb OnMessageFunc) ClientOption {
	return func(o *DialOption) {
		o.cb = OnMessageFunc(cb)
	}
}

// 5.
// 配置自动回应ping frame, 当收到ping， 回一个pong
func WithServerReplyPing() ServerOption {
	return func(o *ConnOption) {
		o.replyPing = true
	}
}

// 配置自动回应ping frame, 当收到ping， 回一个pong
func WithClientReplyPing() ClientOption {
	return func(o *DialOption) {
		o.replyPing = true
	}
}

// 6 配置忽略pong消息
func WithClientIgnorePong() ClientOption {
	return func(o *DialOption) {
		o.ignorePong = true
	}
}

func WithServerIgnorePong() ServerOption {
	return func(o *ConnOption) {
		o.ignorePong = true
	}
}

// 7.
// 设置几倍payload的缓冲区
// 只有解析方式是窗口的时候才有效
// 如果为1.0就是1024 + 14， 如果是2.0就是2048 + 14
func WithServerWindowsMultipleTimesPayloadSize(mt float32) ServerOption {
	return func(o *ConnOption) {
		if mt < 1.0 {
			mt = 1.0
		}
		o.windowsMultipleTimesPayloadSize = mt
	}
}

func WithClientWindowsMultipleTimesPayloadSize(mt float32) ClientOption {
	return func(o *DialOption) {
		if mt < 1.0 {
			mt = 1.0
		}
		o.windowsMultipleTimesPayloadSize = mt
	}
}

// 10 配置解压缩
func WithClientDecompression() ClientOption {
	return func(o *DialOption) {
		o.Decompression = true
	}
}

func WithServerDecompression() ServerOption {
	return func(o *ConnOption) {
		o.Decompression = true
	}
}

// 11 关闭bufio clear hack优化
func WithServerDisableBufioClearHack() ServerOption {
	return func(o *ConnOption) {
		o.disableBufioClearHack = true
	}
}

func WithClientDisableBufioClearHack() ClientOption {
	return func(o *DialOption) {
		o.disableBufioClearHack = true
	}
}

// 13. 配置延迟发送
// 配置延迟最大发送时间
func WithServerMaxDelayWriteDuration(d time.Duration) ServerOption {
	return func(o *ConnOption) {
		o.maxDelayWriteDuration = d
	}
}

// 13. 配置延迟发送
// 配置延迟最大发送时间
func WithClientMaxDelayWriteDuration(d time.Duration) ClientOption {
	return func(o *DialOption) {
		o.maxDelayWriteDuration = d
	}
}

// 14.1 配置最大延迟个数.server
func WithServerMaxDelayWriteNum(n int32) ServerOption {
	return func(o *ConnOption) {
		o.maxDelayWriteNum = n
	}
}

// 14.2 配置最大延迟个数.client
func WithClientMaxDelayWriteNum(n int32) ClientOption {
	return func(o *DialOption) {
		o.maxDelayWriteNum = n
	}
}

// 15.1 配置延迟包的初始化buffer大小
func WithServerDelayWriteInitBufferSize(n int32) ServerOption {
	return func(o *ConnOption) {
		o.delayWriteInitBufferSize = n
	}
}

// 15.2 配置延迟包的初始化buffer大小
func WithClientDelayWriteInitBufferSize(n int32) ClientOption {
	return func(o *DialOption) {
		o.delayWriteInitBufferSize = n
	}
}

// 16. 配置读超时时间
//
// 16.1 .设置服务端读超时时间
func WithServerReadTimeout(t time.Duration) ServerOption {
	return func(o *ConnOption) {
		o.readTimeout = t
	}
}

// 16.2 .设置客户端读超时时间
func WithClientReadTimeout(t time.Duration) ClientOption {
	return func(o *DialOption) {
		o.readTimeout = t
	}
}

// 17。 只配置OnClose
// 17.1 配置服务端OnClose
func WithServerOnCloseFunc(onClose func(c *Conn, err error)) ServerOption {
	return func(o *ConnOption) {
		o.cb = OnCloseFunc(onClose)
	}
}

// 17.2 配置客户端OnClose
func WithClientOnCloseFunc(onClose func(c *Conn, err error)) ClientOption {
	return func(o *DialOption) {
		o.cb = OnCloseFunc(onClose)
	}
}

// 18.1 配置服务端Callback相关方法在io event loop中执行
func WithServerCallbackInEventLoop() ServerOption {
	return func(o *ConnOption) {
		o.runInGoTask = "io"
	}
}

// 18.2 配置服务端Callback相关方法在io event loop中执行
func WithClientCallbackInEventLoop() ClientOption {
	return func(o *DialOption) {
		o.runInGoTask = "io"
	}
}

// 默认模式
// 19.1 配置服务端使用stream模式处理请求，go程会复用，保证OnMessage的处理是有序的
func WithServerStreamMode() ServerOption {
	return func(o *ConnOption) {
		o.runInGoTask = "stream2"
	}
}

// 默认模式
// 19.2 配置客户端使用stream模式处理请求，go程会复用，保证OnMessage的处理是有序的
func WithClientStreamMode() ClientOption {
	return func(o *DialOption) {
		o.runInGoTask = "stream2"
	}
}

// 20.1 配置自定义task, 需要确保传入的值是有效的，不然会panic
func WithServerCustomTaskMode(taskName string) ServerOption {
	return func(o *ConnOption) {
		if len(taskName) > 0 {
			o.runInGoTask = taskName
		}
	}
}

// 20.2 配置自定义task, 需要确保传入的值是有效的，不然会panic
func WithClientCustomTaskMode(taskName string) ClientOption {
	return func(o *DialOption) {
		if len(taskName) > 0 {
			o.runInGoTask = taskName
		}
	}
}

// 20.1 配置服务端使用unstream模式处理请求，go程会复用, 但是不保证顺序性，如果你的请求对时序有要求，请不要使用这个模式,
func WithServerUnstreamMode() ServerOption {
	return func(o *ConnOption) {
		o.runInGoTask = "unstream"
	}
}

// 默认stream2，忽略这个API
// 19.2 配置客户端使用stream模式处理请求，go程会复用，但是不保证顺序性，如果你的请求对时序有要求，请不要使用这个模式，
func WithClientUnstreamMode() ClientOption {
	return func(o *DialOption) {
		o.runInGoTask = "unstream"
	}
}

// 20.1 配置event
func WithServerMultiEventLoop(m *MultiEventLoop) ServerOption {
	return func(o *ConnOption) {
		o.multiEventLoop = m
	}
}

// 20.2 配置event
func WithClientMultiEventLoop(m *MultiEventLoop) ClientOption {
	return func(o *DialOption) {
		o.multiEventLoop = m
	}
}

// 21.1 配置压缩和解压缩
func WithServerDecompressAndCompress() ServerOption {
	return func(o *ConnOption) {
		o.Compression = true
		o.Decompression = true
	}
}

// 21.2 配置压缩和解压缩
func WithClientDecompressAndCompress() ClientOption {
	return func(o *DialOption) {
		o.Compression = true
		o.Decompression = true
	}
}

// 21.1 设置客户端支持上下文接管, 默认不支持上下文接管
func WithClientContextTakeover() ClientOption {
	return func(o *DialOption) {
		o.ClientContextTakeover = true
	}
}

// 21.2 设置服务端支持上下文接管, 默认不支持上下文接管
func WithServerContextTakeover() ServerOption {
	return func(o *ConnOption) {
		o.ServerContextTakeover = true
	}
}

// 21.1 设置客户端最大窗口位数，使用上下文接管时，这个参数才有效
func WithClientMaxWindowsBits(bits uint8) ClientOption {
	return func(o *DialOption) {
		if bits < 8 || bits > 15 {
			return
		}
		o.ClientMaxWindowBits = bits
	}
}

// 22.2 设置服务端最大窗口位数, 使用上下文接管时，这个参数才有效
func WithServerMaxWindowBits(bits uint8) ServerOption {
	return func(o *ConnOption) {
		if bits < 8 || bits > 15 {
			return
		}
		o.ServerMaxWindowBits = bits
	}
}

// 22.1 设置客户端最大可以读取的message的大小, 默认没有限制
func WithClientReadMaxMessage(size int64) ClientOption {
	return func(o *DialOption) {
		o.readMaxMessage = size
	}
}

// 22.2 设置服务端最大可以读取的message的大小，默认没有限制
func WithServerReadMaxMessage(size int64) ServerOption {
	return func(o *ConnOption) {
		o.readMaxMessage = size
	}
}