Module exmpp_internals

The module exmpp_internals provides internal functions for other modules.

Authors: Jean-Sebastien Pedron (js.pedron@meetic-corp.com).

Description

The module exmpp_internals provides internal functions for other modules.

Function Index

close_port/1Close a previously spawned port.
driver_dirs/0Return a list of directories to search port drivers in.
gen_close/1Wrapper to abstract the close function of multiple communication modules.
gen_controlling_process/2Wrapper to abstract the controlling_process function of multiple communication modules.
gen_getopts/2Wrapper to abstract the getopts function of multiple communication modules.
gen_peername/1Wrapper to abstract the peername function of multiple communication modules.
gen_recv/2Wrapper to abstract the recv function of multiple communication modules.
gen_send/2Wrapper to abstract the send function of multiple communication modules.
gen_setopts/2Wrapper to abstract the setopts function of multiple communication modules.
gen_sockname/1Wrapper to abstract the sockname function of multiple communication modules.
load_driver/1Load the port driver Driver_Name.
load_driver/2Load the port driver Driver_Name.
open_port/1Spawn a new port driver instance.
unload_driver/1Unload the port driver Driver_Name.

Function Details

close_port/1

close_port(Port) -> true

Close a previously spawned port.

Port was obtained with open_port/1.

driver_dirs/0

driver_dirs() -> Dirs | []

Return a list of directories to search port drivers in.

gen_close/1

gen_close(X1::Socket_Desc) -> ok | {error, posix()}

Wrapper to abstract the close function of multiple communication modules.

gen_controlling_process/2

gen_controlling_process(X1::Socket_Desc, Pid) -> ok | {error, Reason}

Wrapper to abstract the controlling_process function of multiple communication modules.

gen_getopts/2

gen_getopts(X1::Socket_Desc, Options) -> Option_Values | {error, posix()}

Wrapper to abstract the getopts function of multiple communication modules.

gen_peername/1

gen_peername(X1::Socket_Desc) -> {ok, {Address, Port}} | {error, posix()}

Wrapper to abstract the peername function of multiple communication modules.

gen_recv/2

gen_recv(X1::Socket_Desc, Timeout) -> {ok, Packet} | {error, Reason}

Wrapper to abstract the recv function of multiple communication modules.

gen_send/2

gen_send(X1::Socket_Desc, Packet) -> ok | {error, Reason}

Wrapper to abstract the send function of multiple communication modules.

gen_setopts/2

gen_setopts(X1::Socket_Desc, Options) -> ok | {error, posix()}

Wrapper to abstract the setopts function of multiple communication modules.

gen_sockname/1

gen_sockname(X1::Socket_Desc) -> {ok, {Address, Port}} | {error, posix()}

Wrapper to abstract the sockname function of multiple communication modules.

load_driver/1

load_driver(Driver_Name) -> ok

throws {port_driver, load, Reason, Driver_Name}

Load the port driver Driver_Name.

load_driver/2

load_driver(Driver_Name, Dirs) -> ok

throws {port_driver, load, Reason, Driver_Name}

Load the port driver Driver_Name.

The driver is search in Dirs.

open_port/1

open_port(Driver_Name) -> Port

throws {port_driver, open, {posix, Posix_Code}, Driver_Name}

Spawn a new port driver instance.

unload_driver/1

unload_driver(Driver_Name) -> ok

Unload the port driver Driver_Name.


Generated by EDoc, Jan 21 2011, 01:43:50.