This repository was archived by the owner on Oct 7, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathsockerl_connector.html
77 lines (64 loc) · 5.34 KB
/
sockerl_connector.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<!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 sockerl_connector</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="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>
<h1>Module sockerl_connector</h1>
<ul class="index"><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<p><b>Version:</b> 17.9.10</p>
<p><b>Authors:</b> Pouriya Jahanbakhsh (<a href="mailto:pouriya.jahanbakhsh@gmail.com"><tt>pouriya.jahanbakhsh@gmail.com</tt></a>).</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="#send_async-2">send_async/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#send_sync-2">send_sync/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#send_sync-3">send_sync/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#start_link-4">start_link/4</a></td><td>
starts and links a socket connection handler process.</td></tr>
<tr><td valign="top"><a href="#start_link-5">start_link/5</a></td><td></td></tr>
<tr><td valign="top"><a href="#start_link-6">start_link/6</a></td><td></td></tr>
<tr><td valign="top"><a href="#stop-1">stop/1</a></td><td></td></tr>
<tr><td valign="top"><a href="#stop-2">stop/2</a></td><td></td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="send_async-2">send_async/2</a></h3>
<div class="spec">
<p><tt>send_async(Con::<a href="sockerl_types.html#type-name">sockerl_types:name()</a>, Packet::<a href="sockerl_types.html#type-packet">sockerl_types:packet()</a>) -> ok</tt><br></p>
</div>
<h3 class="function"><a name="send_sync-2">send_sync/2</a></h3>
<div class="spec">
<p><tt>send_sync(Con::<a href="sockerl_types.html#type-name">sockerl_types:name()</a>, Packet::<a href="sockerl_types.html#type-packet">sockerl_types:packet()</a>) -> ok | <a href="sockerl_types.html#type-error">sockerl_types:error()</a></tt><br></p>
</div>
<h3 class="function"><a name="send_sync-3">send_sync/3</a></h3>
<div class="spec">
<p><tt>send_sync(Con::<a href="sockerl_types.html#type-name">sockerl_types:name()</a>, Packet::<a href="sockerl_types.html#type-packet">sockerl_types:packet()</a>, Timeout::timeout()) -> ok | <a href="sockerl_types.html#type-error">sockerl_types:error()</a></tt><br></p>
</div>
<h3 class="function"><a name="start_link-4">start_link/4</a></h3>
<div class="spec">
<p><tt>start_link(Mod::module(), InitArg::term(), Host::<a href="sockerl_types.html#type-socket">sockerl_types:socket()</a> | <a href="sockerl_types.html#type-host">sockerl_types:host()</a>, Port::<a href="sockerl_types.html#type-options">sockerl_types:options()</a> | <a href="sockerl_types.html#type-port_number">sockerl_types:port_number()</a>) -> <a href="sockerl_types.html#type-start_return">sockerl_types:start_return()</a></tt><br></p>
</div><p>
starts and links a socket connection handler process.</p>
<h3 class="function"><a name="start_link-5">start_link/5</a></h3>
<div class="spec">
<p><tt>start_link(Mod::module() | <a href="sockerl_types.html#type-register_name">sockerl_types:register_name()</a>, InitArg::term() | module(), Host::<a href="sockerl_types.html#type-host">sockerl_types:host()</a> | term() | <a href="sockerl_types.html#type-start_options">sockerl_types:start_options()</a>, Port::<a href="sockerl_types.html#type-port_number">sockerl_types:port_number()</a> | <a href="sockerl_types.html#type-host">sockerl_types:host()</a>, Opts::<a href="sockerl_types.html#type-options">sockerl_types:options()</a> | <a href="sockerl_types.html#type-port_number">sockerl_types:port_number()</a>) -> <a href="sockerl_types.html#type-start_return">sockerl_types:start_return()</a></tt><br></p>
</div>
<h3 class="function"><a name="start_link-6">start_link/6</a></h3>
<div class="spec">
<p><tt>start_link(Name::<a href="sockerl_types.html#type-register_name">sockerl_types:register_name()</a>, Mod::module(), InitArg::term(), Host::<a href="sockerl_types.html#type-host">sockerl_types:host()</a>, Port::<a href="sockerl_types.html#type-port_number">sockerl_types:port_number()</a>, Opts::<a href="sockerl_types.html#type-options">sockerl_types:options()</a>) -> <a href="sockerl_types.html#type-start_return">sockerl_types:start_return()</a></tt><br></p>
</div>
<h3 class="function"><a name="stop-1">stop/1</a></h3>
<div class="spec">
<p><tt>stop(Con::<a href="sockerl_types.html#type-name">sockerl_types:name()</a>) -> ok</tt><br></p>
</div>
<h3 class="function"><a name="stop-2">stop/2</a></h3>
<div class="spec">
<p><tt>stop(Con::<a href="sockerl_types.html#type-name">sockerl_types:name()</a>, Reason::any()) -> ok</tt><br></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="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, Sep 2 2017, 12:21:14.</i></p>
</body>
</html>