← Back to branch summary

~ubuntu-branches/debian/squeeze/erlang/squeeze

« back to all changes in this revision

Viewing changes to lib/inets/doc/src/httpd_socket.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-05-07 15:07:37 UTC
  • mfrom: (1.2.1 upstream) (5.1.2 sid)
  • Revision ID: james.westby@ubuntu.com-20090507150737-i4yb5elwinm7r0hc
Tags: 1:13.b-dfsg1-1
http://bugs.debian.org/527053
http://bugs.debian.org/526682
http://bugs.debian.org/526627
* Removed another bunch of non-free RFCs from original tarball
  (closes: #527053).
* Fixed build-dependencies list by adding missing comma. This requires
  libsctp-dev again. Also, added libsctp1 dependency to erlang-base and
  erlang-base-hipe packages because the shared library is loaded via
  dlopen now and cannot be added using dh_slibdeps (closes: #526682).
* Weakened dependency of erlang-webtool on erlang-observer to recommends
  to avoid circular dependencies (closes: #526627).
* Added solaris-i386 to HiPE enabled architectures.
* Made script sources in /usr/lib/erlang/erts-*/bin directory executable,
  which is more convenient if a user wants to create a target Erlang system.
* Shortened extended description line for erlang-dev package to make it
  fit 80x25 terminals.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/inets/doc/src/httpd_socket.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE erlref SYSTEM "erlref.dtd">
 
3
 
 
4
<erlref>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>1997</year><year>2009</year>
 
8
      <holder>Ericsson AB. All Rights Reserved.</holder>
 
9
    </copyright>
 
10
    <legalnotice>
 
11
      The contents of this file are subject to the Erlang Public License,
 
12
      Version 1.1, (the "License"); you may not use this file except in
 
13
      compliance with the License. You should have received a copy of the
 
14
      Erlang Public License along with this software. If not, it can be
 
15
      retrieved online at http://www.erlang.org/.
 
16
    
 
17
      Software distributed under the License is distributed on an "AS IS"
 
18
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 
19
      the License for the specific language governing rights and limitations
 
20
      under the License.
 
21
    
 
22
    </legalnotice>
 
23
 
 
24
    <title>httpd_socket</title>
 
25
    <prepared>Joakim Greben&ouml;</prepared>
 
26
    <docno></docno>
 
27
    <date>1997-10-14</date>
 
28
    <rev>2.2</rev>
 
29
    <file>httpd_socket.sgml</file>
 
30
  </header>
 
31
  <module>httpd_socket</module>
 
32
  <modulesummary>Communication utility functions to be used by the Erlang
 
33
    Web server API programmer.</modulesummary>
 
34
  <description>
 
35
    <p>This module provides the Erlang Web server API module programmer
 
36
      with utility functions for generic sockets communication. The
 
37
      appropriate communication mechanism is transparently used, that
 
38
      is <c>ip_comm</c> or <c>ssl</c>.</p>
 
39
  </description>
 
40
  <funcs>
 
41
    <func>
 
42
      <name>deliver(SocketType, Socket, Data) -> Result</name>
 
43
      <fsummary>Send binary data over socket.</fsummary>
 
44
      <type>
 
45
        <v>SocketType = socket_type()</v>
 
46
        <v>Socket = socket()</v>
 
47
        <v>Data = io_list() | binary()</v>
 
48
        <v>Result = socket_closed | void()</v>
 
49
      </type>
 
50
      <desc>
 
51
        <marker id="deliver"></marker>
 
52
        <p><c>deliver/3</c> sends the <c>Binary</c> over the
 
53
          <c>Socket</c> using the specified <c>SocketType</c>. Socket
 
54
          and SocketType should be the socket and the socket_type form
 
55
          the mod record as defined in httpd.hrl</p>
 
56
      </desc>
 
57
    </func>
 
58
    <func>
 
59
      <name>peername(SocketType,Socket) -> {Port,IPAddress}</name>
 
60
      <fsummary>Return the port and IP-address of the remote socket.</fsummary>
 
61
      <type>
 
62
        <v>SocketType = socket_type()</v>
 
63
        <v>Socket = socket()</v>
 
64
        <v>Port = integer()</v>
 
65
        <v>IPAddress = string()</v>
 
66
      </type>
 
67
      <desc>
 
68
        <marker id="peername"></marker>
 
69
        <p><c>peername/3</c> returns the <c>Port</c> and
 
70
          <c>IPAddress</c> of the remote <c>Socket</c>. </p>
 
71
      </desc>
 
72
    </func>
 
73
    <func>
 
74
      <name>resolve() -> HostName</name>
 
75
      <fsummary>Return the official name of the current host.</fsummary>
 
76
      <type>
 
77
        <v>HostName = string()</v>
 
78
      </type>
 
79
      <desc>
 
80
        <marker id="resolve"></marker>
 
81
        <p><c>resolve/0</c> returns the official <c>HostName</c> of
 
82
          the current host. </p>
 
83
      </desc>
 
84
    </func>
 
85
  </funcs>
 
86
 
 
87
  <section>
 
88
    <marker id="see_also"></marker>
 
89
    <title>SEE ALSO</title>
 
90
    <p><seealso marker="httpd">httpd(3)</seealso></p>
 
91
  </section>
 
92
  
 
93
</erlref>
 
94
 
 
95