Erlang -- httpd_socket

User's Guide
Reference Manual
Release Notes
PDF
Top

inets
Reference Manual
Version 6.3.3

Expand All
Contract All

Table of Contents

- inets
  - Top of manual page
  - service_names/0
  - services/0
  - services_info/0
  - start/0
  - start/2
  - start/3
  - start/1
  - stop/0
  - stop/2
- ftp
  - Top of manual page
  - account/2
  - append/2
  - append/3
  - append_bin/3
  - append_chunk/2
  - append_chunk_end/1
  - append_chunk_start/2
  - cd/2
  - close/1
  - delete/2
  - formaterror/1
  - lcd/2
  - lpwd/1
  - ls/1
  - ls/2
  - mkdir/2
  - nlist/1
  - nlist/2
  - open/1
  - open/2
  - pwd/1
  - quote/2
  - recv/2
  - recv/3
  - recv_bin/2
  - recv_chunk/1
  - recv_chunk_start/2
  - rename/3
  - rmdir/2
  - send/2
  - send/3
  - send_bin/3
  - send_chunk/2
  - send_chunk_end/1
  - send_chunk_start/2
  - type/2
  - user/3
  - user/4
- tftp
  - Top of manual page
  - change_config/2
  - change_config/2
  - change_config/2
  - info/1
  - info/1
  - info/1
  - read_file/3
  - start/1
  - write_file/3
  - Logger:error_msg/2
  - Logger:info_msg/2
  - Logger:warning_msg/2
  - Module:abort/3
  - Module:open/6
  - Module:prepare/6
  - Module:read/1
  - Module:write/2
- httpc
  - Top of manual page
  - cancel_request/1
  - cancel_request/2
  - cookie_header/1
  - cookie_header/3
  - cookie_header/2
  - get_options/1
  - get_options/2
  - info/0
  - info/1
  - request/4
  - request/5
  - request/1
  - request/2
  - reset_cookies/0
  - reset_cookies/1
  - set_options/1
  - set_options/2
  - store_cookies/2
  - store_cookies/3
  - stream_next/1
  - which_cookies/0
  - which_cookies/1
  - which_sessions/0
  - which_sessions/1
- httpd
  - Top of manual page
  - info/2
  - info/3
  - info/4
  - info/3
  - info/1
  - info/2
  - parse_query/1
  - reload_config/2
  - Module:do/1
  - Module:load/2
  - Module:remove/1
  - Module:store/2
- httpd_custom_api
  - Top of manual page
  - request_header/1
  - response_default_headers/0
  - response_header/1
- httpd_socket
  - Top of manual page
  - deliver/3
  - peername/2
  - resolve/0
- httpd_util
  - Top of manual page
  - convert_request_date/1
  - create_etag/1
  - day/1
  - decode_hex/1
  - flatlength/1
  - hexlist_to_integer/1
  - integer_to_hexlist/1
  - lookup/2
  - lookup/3
  - lookup_mime/2
  - lookup_mime/3
  - lookup_mime_default/2
  - lookup_mime_default/3
  - message/3
  - month/1
  - multi_lookup/2
  - reason_phrase/1
  - rfc1123_date/0
  - rfc1123_date/2
  - split/3
  - split_path/1
  - split_script_path/1
  - strip/1
  - suffix/1
- mod_alias
  - Top of manual page
  - default_index/2
  - path/3
  - real_name/3
  - real_script_name/3
- mod_auth
  - Top of manual page
  - add_group_member/5
  - add_group_member/3
  - add_group_member/4
  - add_user/2
  - add_user/6
  - add_user/5
  - delete_group/4
  - delete_group/2
  - delete_group_member/5
  - delete_group_member/3
  - delete_group_member/4
  - delete_user/4
  - delete_user/3
  - delete_user/2
  - get_user/4
  - get_user/3
  - get_user/2
  - list_group_members/4
  - list_group_members/2
  - list_group_members/3
  - list_groups/3
  - list_groups/1
  - list_groups/2
  - list_users/3
  - list_users/1
  - list_users/2
  - update_password/6
  - update_password/5
- mod_esi
  - Top of manual page
  - deliver/2
  - Module:Function/2
  - Module:Function/3
- mod_security
  - Top of manual page
  - block_user/5
  - block_user/4
  - list_auth_users/2
  - list_auth_users/3
  - list_auth_users/1
  - list_auth_users/2
  - list_blocked_users/2
  - list_blocked_users/3
  - list_blocked_users/1
  - list_blocked_users/2
  - unblock_user/3
  - unblock_user/4
  - unblock_user/2
  - unblock_user/3
  - Module:event/5
  - Module:event/4
- http_uri
  - Top of manual page
  - decode/1
  - encode/1
  - parse/1
  - parse/2
  - scheme_defaults/0

# httpd_socket

### MODULE

httpd_socket

### MODULE SUMMARY

Communication utility functions to be used by the Erlang web server API programmer.

### DESCRIPTION

This module provides the Erlang web server API module programmer with utility functions for generic sockets communication. The appropriate communication mechanism is transparently used, that is, ip_comm or ssl.

### EXPORTS

deliver(SocketType, Socket, Data) -> Result

Types:

SocketType = socket_type()
Socket = socket()
Data = io_list() | binary()
Result = socket_closed | void()

deliver/3 sends Data over Socket using the specified SocketType. Socket and SocketType is to be the socket and the socket_type form the mod record as defined in httpd.hrl

peername(SocketType,Socket) -> {Port,IPAddress}

Types:

SocketType = socket_type()
Socket = socket()
Port = integer()
IPAddress = string()

peername/2 returns the Port and IPAddress of the remote Socket.

resolve() -> HostName

Types:

HostName = string()

resolve/0 returns the official HostName of the current host.

### SEE ALSO

httpd(3)