table of contents
other versions
- jessie 1:17.3-dfsg-4+deb8u2
- jessie-backports 1:19.2.1+dfsg-2+deb9u1~bpo8+1
- stretch 1:19.2.1+dfsg-2+deb9u2
- testing 1:21.2.5+dfsg-1
- unstable 1:21.2.6+dfsg-1
- experimental 1:22.0~rc1+dfsg-1
inets(3erl) | Erlang Module Definition | inets(3erl) |
NAME¶
inets - The Inets services API.DESCRIPTION¶
This module provides the most basic API to the clients and servers that are part of the Inets application, such as start and stop.DATA TYPES¶
Type definitions that are used more than once in this module: service() = ftpc | tftp | httpc | httpd property() = atom()EXPORTS¶
services() -> [{Service, Pid}]
Types:
Service = service()
Pid = pid()
Returns a list of currently running services.
services_info() -> [{Service, Pid, Info}]
Note:
Services started as stand_alone are not listed.
Types:
Service = service()
Pid = pid()
Info = [{Option, Value}]
Option = property()
Value = term()
Returns a list of currently running services where each service is described by
an [{Option, Value}] list. The information in the list is specific for
each service and each service has probably its own info function that gives
more details about the service.
service_names() -> [Service]
Types:
Service = service()
Returns a list of available service names.
start() ->
Types:
Type = permanent | transient | temporary
Starts the Inets application. Default type is temporary. See also
application(3erl).
start(Service, ServiceConfig) -> {ok, Pid} | {error, Reason}
Types:
Service = service()
ServiceConfig = [{Option, Value}]
Option = property()
Value = term()
How = inets | stand_alone - default is inets.
Dynamically starts an Inets service after the Inets application
has been started.
stop() -> ok
Note:
Dynamically started services are not handled by application takeover and
failover behavior when Inets is run as a distributed application. Nor
are they automatically restarted when the Inets application is
restarted. As long as the Inets application is operational, they are
supervised and can be soft code upgraded.
A service started as stand_alone, that is, the service is not started as
part of the Inets application, lose all OTP application benefits, such
as soft upgrade. The stand_alone-service is linked to the process that
started it. Usually some supervision functionality is still in place and in
some sense the calling process becomes the top supervisor.
Stops the Inets application. See also application(3erl).
stop(Service, Reference) -> ok | {error, Reason}
Types:
Service = service() | stand_alone
Reference = pid() | term() - service-specified reference
Reason = term()
Stops a started service of the Inets application or takes down a
stand_alone-service gracefully. When option stand_alone is used
in start, only the pid is a valid argument to stop.
SEE ALSO¶
ftp(3erl), httpc(3erl), httpd(3erl), tftp(3erl)inets 6.3.4 | Ericsson AB |