Skip to content

Commit 7cfb8e4

Browse files
committed
fix documentation, comment, status message typos
1 parent 2708d5c commit 7cfb8e4

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ $ chisel client --help
136136
137137
<server> is the URL to the chisel server.
138138
139-
<remote>s are remote connections tunnelled through the server, each of
139+
<remote>s are remote connections tunneled through the server, each of
140140
which come in the form:
141141
142142
<local-host>:<local-port>:<remote-host>:<remote-port>
@@ -239,7 +239,7 @@ localhost:1080
239239

240240
### Performance
241241

242-
With [crowbar](https://github.com/q3k/crowbar), a connection is tunnelled by repeatedly querying the server with updates. This results in a large amount of HTTP and TCP connection overhead. Chisel overcomes this using WebSockets combined with [crypto/ssh](https://golang.org/x/crypto/ssh) to create hundreds of logical connections, resulting in **one** TCP connection per client.
242+
With [crowbar](https://github.com/q3k/crowbar), a connection is tunneled by repeatedly querying the server with updates. This results in a large amount of HTTP and TCP connection overhead. Chisel overcomes this using WebSockets combined with [crypto/ssh](https://golang.org/x/crypto/ssh) to create hundreds of logical connections, resulting in **one** TCP connection per client.
243243

244244
In this simple benchmark, we have:
245245

client/client.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ func (c *Client) Wait() error {
249249
return <-c.runningc
250250
}
251251

252-
//Close manual stops the client
252+
//Close manually stops the client
253253
func (c *Client) Close() error {
254254
c.running = false
255255
if c.sshConn == nil {

main.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ var serverHelp = `
9494
variable PORT and fallsback to port 8080).
9595
9696
--key, An optional string to seed the generation of a ECDSA public
97-
and private key pair. All commications will be secured using this
97+
and private key pair. All communications will be secured using this
9898
key pair. Share the subsequent fingerprint with clients to enable detection
9999
of man-in-the-middle attacks (defaults to the CHISEL_KEY environment
100100
variable, otherwise a new key is generate each run).
@@ -185,7 +185,7 @@ var clientHelp = `
185185
186186
<server> is the URL to the chisel server.
187187
188-
<remote>s are remote connections tunnelled through the server, each of
188+
<remote>s are remote connections tunneled through the server, each of
189189
which come in the form:
190190
191191
<local-host>:<local-port>:<remote-host>:<remote-port>

server/handler.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import (
1515
"github.com/jpillora/chisel/share"
1616
)
1717

18-
// handleClientHandler is the main http sebsocket handler for the chisel server
18+
// handleClientHandler is the main http websocket handler for the chisel server
1919
func (s *Server) handleClientHandler(w http.ResponseWriter, r *http.Request) {
2020
//websockets upgrade AND has chisel prefix
2121
upgrade := strings.ToLower(r.Header.Get("Upgrade"))
@@ -43,7 +43,7 @@ func (s *Server) handleClientHandler(w http.ResponseWriter, r *http.Request) {
4343
w.Write([]byte("Not found"))
4444
}
4545

46-
// handleWebsocket is responsible for hanlding the websocket connection
46+
// handleWebsocket is responsible for handling the websocket connection
4747
func (s *Server) handleWebsocket(w http.ResponseWriter, req *http.Request) {
4848
id := atomic.AddInt32(&s.sessCount, 1)
4949
clog := s.Fork("session#%d", id)
@@ -160,7 +160,7 @@ func (s *Server) handleSocksStream(l *chshare.Logger, src io.ReadWriteCloser) {
160160
conn := chshare.NewRWCConn(src)
161161
// conn.SetDeadline(time.Now().Add(30 * time.Second))
162162
atomic.AddInt32(&s.connOpen, 1)
163-
l.Debugf("%s Openning", s.connStatus())
163+
l.Debugf("%s Opening", s.connStatus())
164164
err := s.socksServer.ServeConn(conn)
165165
atomic.AddInt32(&s.connOpen, -1)
166166
if err != nil && !strings.HasSuffix(err.Error(), "EOF") {

server/server.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ func (s *Server) Wait() error {
153153
return s.httpServer.Wait()
154154
}
155155

156-
// Close forciable closes the http server
156+
// Close forcibly closes the http server
157157
func (s *Server) Close() error {
158158
return s.httpServer.Close()
159159
}

0 commit comments

Comments
 (0)