Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Serve ¶
Serve starts handling events for the specified addresses.
Addresses should use a scheme prefix and be formatted like `tcp://192.168.0.10:9851` or `unix://socket`. Valid network schemes:
tcp - bind to both IPv4 and IPv6 tcp4 - IPv4 tcp6 - IPv6 udp - bind to both IPv4 and IPv6 udp4 - IPv4 udp6 - IPv6 unix - Unix Domain Socket
The "tcp" network scheme is assumed when one is not specified.
Types ¶
type AtomicBool ¶
type AtomicBool struct {
// contains filtered or unexported fields
}
AtomicBool 原子操作封装的 bool 类型
type Events ¶
type Events struct { // NumLoops sets the number of loops to use for the server. Setting this // to a value greater than 1 will effectively make the server // multithreaded for multi-core machines. Which means you must take care // with synchonizing memory between all event callbacks. Setting to 0 or 1 // will run the server single-threaded. Setting to -1 will automatically // assign this value equal to runtime.NumProcs(). NumLoops int // LoadBalance sets the load balancing method. Load balancing is always a // best effort to attempt to distribute the incoming connections between // multiple loops. This option is only works when NumLoops is set. LoadBalance LoadBalance // Serving fires when the server can accept connections. The server // parameter has information and various utilities. Serving func(server Server) (action Action) // Opened fires when a new connection has opened. // The info parameter has information about the connection such as // it's local and remote address. // Use the out return value to write data to the connection. // The opts return value is used to set connection options. Opened func(c *Conn) (out []byte, opts Options, action Action) // Closed fires when a connection has closed. // The err parameter is the last known connection error. Closed func(c *Conn, err error) (action Action) // PreWrite fires just before any data is written to any client socket. PreWrite func() // Data fires when a connection sends the server data. // The in parameter is the incoming data. // Use the out return value to write data to the connection. Data func(c *Conn, in *ringbuffer.RingBuffer) (out []byte, action Action) // Tick fires immediately after the server starts and will fire again // following the duration specified by the delay return value. Tick func() (delay time.Duration, action Action) }
Events represents the server events for the Serve call. Each event has an Action return value that is used manage the state of the connection and server.
type LoadBalance ¶
type LoadBalance int
LoadBalance sets the load balancing method.
const ( // Random requests that connections are randomly distributed. Random LoadBalance = iota // RoundRobin requests that connections are distributed to a loop in a // round-robin fashion. RoundRobin // LeastConnections assigns the next accepted connection to the loop with // the least number of active connections. LeastConnections )
type Server ¶
type Server struct { // The addrs parameter is an array of listening addresses that align // with the addr strings passed to the Serve function. Addrs []net.Addr // NumLoops is the number of loops that the server is using. NumLoops int }
Server represents a server context which provides information about the running server and has control functions for managing state.
Click to show internal directories.
Click to hide internal directories.