# Class: ShellService

## vertx-shell-js/shell_service~ ShellService

#### new ShellService()

The shell service, provides a remotely accessible shell available via Telnet or SSH according to the

Source:
  - vertx-shell-js/shell_service.js, line 31

### Methods

#### server() → {ShellServer}

Source:
  - vertx-shell-js/shell_service.js, line 64

##### Returns:

- the shell server
- Type
    ShellServer

#### start(startHandler)

Start the shell service, this is an asynchronous start.

##### Parameters:

Name | Type | Description
--- | --- | ---
`startHandler` | function | handler for getting notified when service is started

Source:
  - vertx-shell-js/shell_service.js, line 42

#### stop(stopHandler)

Stop the shell service, this is an asynchronous start.

##### Parameters:

Name | Type | Description
--- | --- | ---
`stopHandler` | function | handler for getting notified when service is stopped

Source:
  - vertx-shell-js/shell_service.js, line 77