From a2a1883e04aaa923b385cbbc496395ed5bf1dc17 Mon Sep 17 00:00:00 2001 From: tmanevik Date: Mon, 6 Jul 2015 21:21:27 +0200 Subject: Inets Reference Manual Editorial changes --- lib/inets/doc/src/inets.xml | 93 ++++++++++++++++++++++----------------------- 1 file changed, 46 insertions(+), 47 deletions(-) (limited to 'lib/inets/doc/src/inets.xml') diff --git a/lib/inets/doc/src/inets.xml b/lib/inets/doc/src/inets.xml index f96ff5f8fb..2bb5427465 100644 --- a/lib/inets/doc/src/inets.xml +++ b/lib/inets/doc/src/inets.xml @@ -30,21 +30,21 @@ inets - The inets services API + The Inets services API.

This module provides the most basic API to the - clients and servers, that are part of the Inets application, - such as start and stop.

+ clients and servers that are part of the Inets application, + such as start and stop.
- COMMON DATA TYPES + DATA TYPES

Type definitions that are used more than once in - this module:

-

service() = ftpc | tftp | httpc | httpd

-

property() = atom()

+ this module:

+

service() = ftpc | tftp | httpc | httpd

+

property() = atom()

@@ -52,7 +52,7 @@ services() -> [{Service, Pid}] - Returns a list of currently running services. + Returns a list of currently running services. Service = service() Pid = pid() @@ -60,7 +60,7 @@

Returns a list of currently running services.

-

Services started as stand_alone will not be listed.

+

Services started as stand_alone are not listed.

 @@ -70,8 +70,8 @@ services_info() -> [{Service, Pid, Info}] Returns a list of currently running services where - each service is described by a [{Option, Value}] - list. + each service is described by an [{Option, Value}] + list. Service = service() Pid = pid() @@ -81,11 +81,10 @@

Returns a list of currently running services where each - service is described by a [{Option, Value}] list. The - information given in the list is specific for each service - and it is probable that each service will have its own info - function that gives you even more details about the - service.

+ 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.

 @@ -107,14 +106,14 @@ start() -> start(Type) -> ok | {error, Reason} - Starts the Inets application. + Starts the Inets application. Type = permanent | transient | temporary -

Starts the Inets application. Default type - is temporary. See also - application(3).

+

Starts the Inets application. Default type + is temporary. See also + application(3).

 @@ -122,10 +121,10 @@ stop() -> ok - Stops the inets application. + Stops the Inets application. -

Stops the inets application. See also - application(3).

+

Stops the Inets application. See also + application(3).

 @@ -134,32 +133,32 @@ start(Service, ServiceConfig) -> {ok, Pid} | {error, Reason} start(Service, ServiceConfig, How) -> {ok, Pid} | {error, Reason} - Dynamically starts an inets - service after the inets application has been started. + Dynamically starts an Inets + service after the Inets application has been started. Service = service() ServiceConfig = [{Option, Value}] Option = property() Value = term() - How = inets | stand_alone - default is inets + How = inets | stand_alone - default is inets. -

Dynamically starts an inets service after the inets - application has been started.

+

Dynamically starts an Inets service after the Inets + application has been started.

-

Dynamically started services will not be handled by - application takeover and failover behavior when inets is - run as a distributed application. Nor will they be - automatically restarted when the inets application is - restarted, but as long as the inets application is up and - running they will be supervised and may be soft code - upgraded. Services started as stand_alone, - e.i. the service is not started as part of the inets - application, will lose all OTP application benefits such - as soft upgrade. The "stand_alone-service" will be linked to - the process that started it. In most cases some of the - supervision functionality will still be in place and in - some sense the calling process has now become the top +

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.

 @@ -169,17 +168,17 @@ stop(Service, Reference) -> ok | {error, Reason} - Stops a started service of the inets application or takes - down a "stand_alone-service" gracefully. + Stops a started service of the Inets application or takes + down a stand_alone service gracefully. Service = service() | stand_alone - Reference = pid() | term() - service specified reference + 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 the - stand_alone option is used in start, +

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.

-- cgit v1.2.3