File: httpd_socket.html

package info (click to toggle)
erlang-doc-html 1%3A11.b.2-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 23,284 kB
  • ctags: 10,724
  • sloc: erlang: 505; ansic: 323; makefile: 62; perl: 61; sh: 45
file content (131 lines) | stat: -rw-r--r-- 3,238 bytes parent folder | download
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>httpd_socket</TITLE>
  <SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
  <STYLE TYPE="text/css">
<!--
    .REFBODY     { margin-left: 13mm }
    .REFTYPES    { margin-left: 8mm }
-->
  </STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
      ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
  <IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>httpd_socket</H1>
</CENTER>

<H3>MODULE</H3>
<DIV CLASS=REFBODY>
httpd_socket


</DIV>

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
Communication utility functions to be used by the
Erlang Webserver API programmer.


</DIV>

<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>

<P>This module provides the Erlang Webserver API module programmer
with utility functions for generic sockets communication. The
appropriate communication mechanism is transparently used, that
is <CODE>ip_comm</CODE> or <CODE>ssl</CODE>.

</DIV>

<H3>EXPORTS</H3>

<P><A NAME="deliver/3"><STRONG><CODE>deliver(SocketType, Socket, Data) -&#62; Result</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>SocketType = socket_type()</CODE></STRONG><BR>
<STRONG><CODE>Socket = socket()</CODE></STRONG><BR>
<STRONG><CODE>Data = io_list() | binary()</CODE></STRONG><BR>
<STRONG><CODE>Result = socket_closed | void()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>
<A NAME="deliver"><!-- Empty --></A>
<P><CODE>deliver/3</CODE> sends the <CODE>Binary</CODE> over the
         <CODE>Socket</CODE> using the specified <CODE>SocketType</CODE>. Socket
         and SocketType should be the socket and the socket_type form
         the mod record as defined in httpd.hrl

</DIV>

<P><A NAME="peername/2"><STRONG><CODE>peername(SocketType,Socket) -&#62; {Port,IPAddress}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>SocketType = socket_type()</CODE></STRONG><BR>
<STRONG><CODE>Socket = socket()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>IPAddress = string()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>
<A NAME="peername"><!-- Empty --></A>
<P><CODE>peername/3</CODE> returns the <CODE>Port</CODE> and
         <CODE>IPAddress</CODE> of the remote <CODE>Socket</CODE>. 

</DIV>

<P><A NAME="resolve/0"><STRONG><CODE>resolve() -&#62; HostName</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>HostName = string()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>
<A NAME="resolve"><!-- Empty --></A>
<P><CODE>resolve/0</CODE> returns the official <CODE>HostName</CODE> of
         the current host. 

</DIV>
<A NAME="see_also"><!-- Empty --></A>
<H3>SEE ALSO</H3>
<DIV CLASS=REFBODY>

<P><A HREF="httpd.html">httpd(3)</A>

</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Joakim Greben - support@erlang.ericsson.se<BR>

</DIV>
<CENTER>
<HR>
<SMALL>inets 4.7.6<BR>
Copyright &copy; 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>