package
1.6.4
Repository: https://github.com/aldelo/common.git
Documentation: pkg.go.dev

# Structs

TCPClient defines tcp client connection struct ServerIP = tcp server ip address ServerPort = tcp server port ReceiveHandler = func handler to be triggered when data is received from tcp server ErrorHandler = func handler to be triggered when error is received from tcp server (while performing reader service) ReadBufferSize = default: 1024, defines the read buffer byte size, if > 65535, defaults to 1024 ReaderYieldDuration = default: 25ms, defines the amount of time yielded during each reader service loop cycle, if > 1000ms, defaults to 25ms ReadDeadLineDuration = default: 1000ms, defines the amount of time given to read action before timeout, valid range is 250ms - 5000ms WriteDeadLineDuration = default: 0, duration value used to control write timeouts, this value is added to current time during write timeout set action.
TCPServer defines a concurrent tcp server for handling inbound client requests, and sending back responses Port = this tcp server port number to listen on ListenerErrorHandler = func to trigger when listener caused error event, this also signifies the end of tcp server listener serving mode ClientReceiveHandler = func to trigger when this tcp server receives data from client, the writeToClientFunc is provided for sending data back to the connected client ClientErrorHandler = func to trigger when this tcp server detected tcp client error during data receive event ReadBufferSize = default 1024, cannot be greater than 65535, defines the byte length of read buffer ListenerYieldDuration = default 0, no yield, valid range is 0 - 250ms, the amount of time to yield to cpu during listener accept loop cycle ReaderYieldDuration = default 25ms, the amount of time to yield to cpu process during each cycle of Read loop ReadDeadLineDuration = default 1000ms, the amount of time to wait for read action before timeout, valid range is 250ms - 5000ms WriteDeadLineDuration = the amount of time to wait for write action before timeout, if 0, then no timeout.