# Module cloudi_service_router_ssh_server

- Description
- Data Types
- Function Index
- Function Details

### CloudI Router Service SSH Server

.

Copyright © 2018-2020 Michael Truog

Version: 2.0.1 May 27 2021 02:29:17 ------------------------------------------------------------------------

Behaviours: `ssh_daemon_channel`.

Authors: Michael Truog (`mjtruog at protonmail dot com`).

## Description

### CloudI Router Service SSH Server

## Data Types

### options()

`options() = [{ip, inet:ip_address() | any | loopback} | {port, pos_integer()} | {inet, inet | inet6 | undefined} | {user_dir, string()} | {system_dir, string()}]`

### state()

`state() = #ssh_server{config_compression = 0..9, config_inet = inet | inet6 | undefined, config_port = pos_integer(), config_system_dir = string(), config_user_dir = string(), process = undefined | ssh:daemon_ref()}`

## Function Index

config_compression/1 |
config_inet/1 |
config_port/1 |
config_system_dir/1 |
config_user_dir/1 |
destroy/1 |
handle_msg/2 |
handle_ssh_msg/2 |
init/1 |
new/3 |
terminate/2 |

## Function Details

### config_compression/1

`config_compression(Ssh_server::#ssh_server{config_compression = 0..9, config_inet = inet | inet6 | undefined, config_port = pos_integer(), config_system_dir = string(), config_user_dir = string(), process = undefined | ssh:daemon_ref()} | undefined) -> 0..9`

### config_inet/1

`config_inet(Ssh_server::#ssh_server{config_compression = 0..9, config_inet = inet | inet6 | undefined, config_port = pos_integer(), config_system_dir = string(), config_user_dir = string(), process = undefined | ssh:daemon_ref()} | undefined) -> inet | inet6 | undefined`

### config_port/1

`config_port(Ssh_server::#ssh_server{config_compression = 0..9, config_inet = inet | inet6 | undefined, config_port = pos_integer(), config_system_dir = string(), config_user_dir = string(), process = undefined | ssh:daemon_ref()} | undefined) -> pos_integer()`

### config_system_dir/1

`config_system_dir(Ssh_server::#ssh_server{config_compression = 0..9, config_inet = inet | inet6 | undefined, config_port = pos_integer(), config_system_dir = string(), config_user_dir = string(), process = undefined | ssh:daemon_ref()} | undefined) -> string() | undefined`

### config_user_dir/1

`config_user_dir(Ssh_server::#ssh_server{config_compression = 0..9, config_inet = inet | inet6 | undefined, config_port = pos_integer(), config_system_dir = string(), config_user_dir = string(), process = undefined | ssh:daemon_ref()} | undefined) -> string() | undefined`

### destroy/1

`destroy(Ssh_server::state() | undefined) -> ok`

### handle_msg/2

`handle_msg(X1, State) -> any()`

### handle_ssh_msg/2

`handle_ssh_msg(X1, Ssh_server_connection) -> any()`

### init/1

`init(X1) -> any()`

### new/3

`new(Options::options() | undefined, Environment::cloudi_environment:lookup(), Dispatcher::cloudi_service:dispatcher()) -> state() | undefined`

### terminate/2

`terminate(Reason, State) -> any()`

Generated by EDoc