Skip to content

Commit 4fac57e

Browse files
henrybarretogustavosbarreto
authored andcommitted
docs(agent): add short description to listen function
1 parent 72d1067 commit 4fac57e

File tree

1 file changed

+1
-4
lines changed

1 file changed

+1
-4
lines changed

pkg/agent/agent.go

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -411,10 +411,7 @@ func closeHandler(a *Agent, serv *server.Server) func(c echo.Context) error {
411411
}
412412
}
413413

414-
// Listen creates a new SSH server, tunnel to ShellHub and listen for incoming connections.
415-
//
416-
// listening parameter is a channel that is notified when the agent is listing for connections. It can be used to
417-
// start to ping the server, synchronizing device information or other tasks.
414+
// Listen creates a new SSH server, through a reverse connection between the Agent and the ShellHub server.
418415
func (a *Agent) Listen(ctx context.Context) error {
419416
a.mode.Serve(a)
420417

0 commit comments

Comments
 (0)