-
Notifications
You must be signed in to change notification settings - Fork 0
/
gtcp_server.go
190 lines (170 loc) · 5.31 KB
/
gtcp_server.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package gtcp
import (
"crypto/tls"
"fmt"
"net"
"sync"
"github.com/gogf/gf/v2/container/gmap"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/v2/text/gstr"
"github.com/gogf/gf/v2/util/gconv"
)
const (
// FreePortAddress marks the server listens using random free port.
FreePortAddress = ":0"
)
const (
defaultServer = "default"
)
// Server is a TCP server.
type Server struct {
mu sync.Mutex // Used for Server.listen concurrent safety. -- The golang test with data race checks this.
listen net.Listener // TCP address listener.
address string // Server listening address.
handler func(*Conn) // Connection handler.
tlsConfig *tls.Config // TLS configuration.
}
// Map for name to server, for singleton purpose.
var serverMapping = gmap.NewStrAnyMap(true)
// GetServer returns the TCP server with specified `name`,
// or it returns a new normal TCP server named `name` if it does not exist.
// The parameter `name` is used to specify the TCP server
func GetServer(name ...interface{}) *Server {
serverName := defaultServer
if len(name) > 0 && name[0] != "" {
serverName = gconv.String(name[0])
}
return serverMapping.GetOrSetFuncLock(serverName, func() interface{} {
return NewServer("", nil)
}).(*Server)
}
// NewServer creates and returns a new normal TCP server.
// The parameter `name` is optional, which is used to specify the instance name of the server.
func NewServer(address string, handler func(*Conn), name ...string) *Server {
s := &Server{
address: address,
handler: handler,
}
if len(name) > 0 && name[0] != "" {
serverMapping.Set(name[0], s)
}
return s
}
// NewServerTLS creates and returns a new TCP server with TLS support.
// The parameter `name` is optional, which is used to specify the instance name of the server.
func NewServerTLS(address string, tlsConfig *tls.Config, handler func(*Conn), name ...string) *Server {
s := NewServer(address, handler, name...)
s.SetTLSConfig(tlsConfig)
return s
}
// NewServerKeyCrt creates and returns a new TCP server with TLS support.
// The parameter `name` is optional, which is used to specify the instance name of the server.
func NewServerKeyCrt(address, crtFile, keyFile string, handler func(*Conn), name ...string) (*Server, error) {
s := NewServer(address, handler, name...)
if err := s.SetTLSKeyCrt(crtFile, keyFile); err != nil {
return nil, err
}
return s, nil
}
// SetAddress sets the listening address for server.
func (s *Server) SetAddress(address string) {
s.address = address
}
// GetAddress get the listening address for server.
func (s *Server) GetAddress() string {
return s.address
}
// SetHandler sets the connection handler for server.
func (s *Server) SetHandler(handler func(*Conn)) {
s.handler = handler
}
// SetTLSKeyCrt sets the certificate and key file for TLS configuration of server.
func (s *Server) SetTLSKeyCrt(crtFile, keyFile string) error {
tlsConfig, err := LoadKeyCrt(crtFile, keyFile)
if err != nil {
return err
}
s.tlsConfig = tlsConfig
return nil
}
// SetTLSConfig sets the TLS configuration of server.
func (s *Server) SetTLSConfig(tlsConfig *tls.Config) {
s.tlsConfig = tlsConfig
}
// Close closes the listener and shutdowns the server.
func (s *Server) Close() error {
s.mu.Lock()
defer s.mu.Unlock()
if s.listen == nil {
return nil
}
return s.listen.Close()
}
// Run starts running the TCP Server.
func (s *Server) Run() (err error) {
if s.handler == nil {
err = gerror.NewCode(gcode.CodeMissingConfiguration, "start running failed: socket handler not defined")
return
}
if s.tlsConfig != nil {
// TLS Server
s.mu.Lock()
s.listen, err = tls.Listen("tcp", s.address, s.tlsConfig)
s.mu.Unlock()
if err != nil {
err = gerror.Wrapf(err, `tls.Listen failed for address "%s"`, s.address)
return
}
} else {
// Normal Server
var tcpAddr *net.TCPAddr
if tcpAddr, err = net.ResolveTCPAddr("tcp", s.address); err != nil {
err = gerror.Wrapf(err, `net.ResolveTCPAddr failed for address "%s"`, s.address)
return err
}
s.mu.Lock()
s.listen, err = net.ListenTCP("tcp", tcpAddr)
s.mu.Unlock()
if err != nil {
err = gerror.Wrapf(err, `net.ListenTCP failed for address "%s"`, s.address)
return err
}
}
// Listening loop.
for {
var conn net.Conn
if conn, err = s.listen.Accept(); err != nil {
err = gerror.Wrapf(err, `Listener.Accept failed`)
return err
} else if conn != nil {
go s.handler(NewConnByNetConn(conn))
}
}
}
// GetListenedAddress retrieves and returns the address string which are listened by current server.
func (s *Server) GetListenedAddress() string {
if !gstr.Contains(s.address, FreePortAddress) {
return s.address
}
var (
address = s.address
listenedPort = s.GetListenedPort()
)
address = gstr.Replace(address, FreePortAddress, fmt.Sprintf(`:%d`, listenedPort))
return address
}
// GetListenedPort retrieves and returns one port which is listened to by current server.
func (s *Server) GetListenedPort() int {
s.mu.Lock()
defer s.mu.Unlock()
if ln := s.listen; ln != nil {
return ln.Addr().(*net.TCPAddr).Port
}
return -1
}