Current section
Files
Jump to
Current section
Files
doc/cloudi_service_router_ssh_server.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Module cloudi_service_router_ssh_server</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>
<h1>Module cloudi_service_router_ssh_server</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<h3><a name="CloudI_Router_Service_SSH_Server">CloudI Router Service SSH Server</a></h3>.
<p>Copyright © 2018-2020 Michael Truog</p>
<p><b>Version:</b> 2.0.1 Nov 26 2020 19:52:42
------------------------------------------------------------------------</p>
<p><b>Behaviours:</b> <a href="ssh_daemon_channel.html"><tt>ssh_daemon_channel</tt></a>.</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog at protonmail dot com"><tt>mjtruog at protonmail dot com</tt></a>).</p>
<h2><a name="description">Description</a></h2>
<h3><a name="CloudI_Router_Service_SSH_Server">CloudI Router Service SSH Server</a></h3>
<h2><a name="types">Data Types</a></h2>
<h3 class="typedecl"><a name="type-options">options()</a></h3>
<p><tt>options() = [{ip, <a href="inet.html#type-ip_address">inet:ip_address()</a> | any | loopback} | {port, pos_integer()} | {inet, inet | inet6 | undefined} | {user_dir, string()} | {system_dir, string()}]</tt></p>
<h3 class="typedecl"><a name="type-state">state()</a></h3>
<p><tt>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 | <a href="ssh.html#type-daemon_ref">ssh:daemon_ref()</a>}</tt></p>
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#config_compression-1">config_compression/1</a></td><td></td></tr>
<tr><td valign="top"><a href="#config_inet-1">config_inet/1</a></td><td></td></tr>
<tr><td valign="top"><a href="#config_port-1">config_port/1</a></td><td></td></tr>
<tr><td valign="top"><a href="#config_system_dir-1">config_system_dir/1</a></td><td></td></tr>
<tr><td valign="top"><a href="#config_user_dir-1">config_user_dir/1</a></td><td></td></tr>
<tr><td valign="top"><a href="#destroy-1">destroy/1</a></td><td></td></tr>
<tr><td valign="top"><a href="#handle_msg-2">handle_msg/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#handle_ssh_msg-2">handle_ssh_msg/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr>
<tr><td valign="top"><a href="#new-3">new/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="config_compression-1">config_compression/1</a></h3>
<div class="spec">
<p><tt>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 | <a href="ssh.html#type-daemon_ref">ssh:daemon_ref()</a>} | undefined) -> 0..9</tt><br></p>
</div>
<h3 class="function"><a name="config_inet-1">config_inet/1</a></h3>
<div class="spec">
<p><tt>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 | <a href="ssh.html#type-daemon_ref">ssh:daemon_ref()</a>} | undefined) -> inet | inet6 | undefined</tt><br></p>
</div>
<h3 class="function"><a name="config_port-1">config_port/1</a></h3>
<div class="spec">
<p><tt>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 | <a href="ssh.html#type-daemon_ref">ssh:daemon_ref()</a>} | undefined) -> pos_integer()</tt><br></p>
</div>
<h3 class="function"><a name="config_system_dir-1">config_system_dir/1</a></h3>
<div class="spec">
<p><tt>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 | <a href="ssh.html#type-daemon_ref">ssh:daemon_ref()</a>} | undefined) -> string() | undefined</tt><br></p>
</div>
<h3 class="function"><a name="config_user_dir-1">config_user_dir/1</a></h3>
<div class="spec">
<p><tt>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 | <a href="ssh.html#type-daemon_ref">ssh:daemon_ref()</a>} | undefined) -> string() | undefined</tt><br></p>
</div>
<h3 class="function"><a name="destroy-1">destroy/1</a></h3>
<div class="spec">
<p><tt>destroy(Ssh_server::<a href="#type-state">state()</a> | undefined) -> ok</tt><br></p>
</div>
<h3 class="function"><a name="handle_msg-2">handle_msg/2</a></h3>
<div class="spec">
<p><tt>handle_msg(X1, State) -> any()</tt></p>
</div>
<h3 class="function"><a name="handle_ssh_msg-2">handle_ssh_msg/2</a></h3>
<div class="spec">
<p><tt>handle_ssh_msg(X1, Ssh_server_connection) -> any()</tt></p>
</div>
<h3 class="function"><a name="init-1">init/1</a></h3>
<div class="spec">
<p><tt>init(X1) -> any()</tt></p>
</div>
<h3 class="function"><a name="new-3">new/3</a></h3>
<div class="spec">
<p><tt>new(Options::<a href="#type-options">options()</a> | undefined, Environment::<a href="deps/cloudi_core/doc/cloudi_environment.html#type-lookup">cloudi_environment:lookup()</a>, Dispatcher::<a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a>) -> <a href="#type-state">state()</a> | undefined</tt><br></p>
</div>
<h3 class="function"><a name="terminate-2">terminate/2</a></h3>
<div class="spec">
<p><tt>terminate(Reason, State) -> any()</tt></p>
</div>
<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc</i></p>
</body>
</html>