查看源代码 inets (inets v9.3.1)

Inets 服务 API。

此模块为 Inets 应用程序的客户端和服务器提供最基本的 API，例如启动和停止。

数据类型

在此模块中多次使用的类型定义

service() = httpc | httpd

property() = atom()

另请参阅

httpc, httpd

概要

类型

inets_service()

service_info()

函数

service_names()

返回可用服务名称的列表。

services()

返回当前正在运行的服务的列表。

services_info()

返回当前正在运行的服务的列表，其中每个服务都由一个 [{Option, Value}] 列表描述。列表中的信息是特定于每个服务的，并且每个服务可能都有自己的 info 函数，提供有关该服务的更多详细信息。如果特定的服务信息返回 {error, Reason}，则 Info 将包含 Reason 项。

start()

等效于 start/1。

start(Type)

启动 Inets 应用程序。默认类型为 temporary。另请参阅 application。

start(Service, ServiceConfig)

等效于 start/3。

start(Service, ServiceConfig, How)

在 Inets 应用程序启动后，动态启动一个 Inets 服务。

stop()

停止 Inets 应用程序。另请参阅 application。

stop(Service, Reference)

停止 Inets 应用程序的已启动服务，或者优雅地关闭一个 stand_alone 服务。当在启动中使用选项 stand_alone 时，只有 pid 是停止的有效参数。

类型

inets_service()

（未导出）

-type inets_service() :: httpd | httpc.

service_info()

（未导出）

-type service_info() ::
          {inets_service(), pid(), [{profile, atom()}] | no_such_service | service_not_available}.

函数

service_names()

-spec service_names() -> [inets_service()].

返回可用服务名称的列表。

services()

-spec services() -> [{inets_service(), pid()}] | {error, inets_not_started}.

返回当前正在运行的服务的列表。

注意
以 stand_alone 方式启动的服务不在此列表中。

services_info()

-spec services_info() -> [service_info()] | {error, inets_not_started}.

返回当前正在运行的服务的列表，其中每个服务都由一个 [{Option, Value}] 列表描述。列表中的信息是特定于每个服务的，并且每个服务可能都有自己的 info 函数，提供有关该服务的更多详细信息。如果特定的服务信息返回 {error, Reason}，则 Info 将包含 Reason 项。

start()

-spec start() -> ok | {error, Reason} when Reason :: term().

等效于 start/1。

start(Type)

-spec start(Type) -> ok | {error, Reason} when Type :: application:restart_type(), Reason :: term().

启动 Inets 应用程序。默认类型为 temporary。另请参阅 application。

start(Service, ServiceConfig)

-spec start(Service, ServiceConfig) -> Result
               when
                   Service :: inets_service(),
                   ServiceConfig :: ConfPropList | ConfFile,
                   ConfPropList :: [{Property, Value}],
                   ConfFile :: string(),
                   Property :: term(),
                   Value :: term(),
                   Result :: {ok, pid()} | {error, term()}.

等效于 start/3。

start(Service, ServiceConfig, How)

-spec start(Service, ServiceConfig, How) -> Result
               when
                   Service :: inets_service(),
                   ServiceConfig :: ConfPropList | ConfFile,
                   How :: inets | stand_alone,
                   ConfPropList :: [{Property, Value}],
                   ConfFile :: string(),
                   Property :: term(),
                   Value :: term(),
                   Result :: {ok, pid()} | {error, term()}.

在 Inets 应用程序启动后，动态启动一个 Inets 服务。

注意
当 Inets 作为分布式应用程序运行时，动态启动的服务不受应用程序接管和故障转移行为的影响。当 Inets 应用程序重新启动时，它们也不会自动重新启动。只要 Inets 应用程序运行正常，它们就会受到监控，并且可以进行软代码升级。
以 stand_alone 方式启动的服务，即该服务不是作为 Inets 应用程序的一部分启动的，将失去所有 OTP 应用程序的优势，例如软升级。stand_alone 服务链接到启动它的进程。通常，一些监控功能仍然存在，在某种意义上，调用进程成为顶级监控器。
警告
stand_alone 选项被认为是已弃用的。

stop()

-spec stop() -> ok.

停止 Inets 应用程序。另请参阅 application。

stop(Service, Reference)

-spec stop(Service, Reference) -> ok | {error, Reason}
              when
                  Service :: inets_service() | stand_alone,
                  Reference :: pid() | term(),
                  Reason :: term().

停止 Inets 应用程序的已启动服务，或者优雅地关闭一个 stand_alone 服务。当在启动中使用选项 stand_alone 时，只有 pid 是停止的有效参数。