Behaviours: gen_server.
Authors: Jean-Sébastien Pédron (js.pedron@meetic-corp.com).
abstract datatype: compress_socket()
Compression socket obtained with compress/2
.
close/1 | Turn off compression and close the underlying socket. |
controlling_process/2 | Change the controlling socket of the underlying socket. |
disable_compression/1 | Disable compression and return the underlying socket. |
enable_compression/2 | Enable compression over the given socket. |
get_compress_methods/0 | Return the list of supported compress methods. |
get_engine_driver/1 | Return the port driver name associated to the given engine. |
get_engine_names/0 | Return the list of compression engines. |
get_engine_names/1 | Return the list of compression engines which support the given compress method. |
get_prefered_engine_name/1 | Return the name of the prefered compression engines which support the given compress method. |
getopts/2 | Sets one or more options for a socket. |
is_engine_available/1 | Tell if Engine_Name is available. |
peername/1 | Returns the address and port for the other end of a connection. |
recv/1 | Receive data over a compressed connection. |
recv/2 | Receive data over a compressed connection. |
recv_data/2 | Uncompressed already received data. |
register_engine/3 | Add a new compression engine. |
register_engine/4 | Add a new compression engine. |
send/2 | Send Orig_Packet over a compressed connection. |
setopts/2 | Sets one or more options for a socket. |
sockname/1 | Returns the local address and port number for a socket. |
close(Compress_socket::Compress_Socket) -> ok | {error, Reason}
Turn off compression and close the underlying socket.
controlling_process(Compress_socket::Compress_Socket, Pid) -> ok | {error, Reason}
Change the controlling socket of the underlying socket.
disable_compression(Compress_socket::Compress_Socket) -> Socket_Desc
Disable compression and return the underlying socket.
enable_compression(Socket_Desc, Options) -> Compress_Socket
Enable compression over the given socket.
get_compress_methods() -> [Compress_Method]
Return the list of supported compress methods.
get_engine_driver(Engine_Name) -> Driver_Name
Return the port driver name associated to the given engine.
get_engine_names() -> [Engine_Name]
Return the list of compression engines.
get_engine_names(Compress_Method) -> [Engine_Name]
Return the list of compression engines which support the given compress method.
The list is sorted from the most to the least prefered engine.get_prefered_engine_name(Compress_Method) -> [Engine_Name]
Return the name of the prefered compression engines which support the given compress method.
getopts(Compress_socket::Compress_Socket, Options) -> {ok, Option_Values} | {error, posix()}
Sets one or more options for a socket.
is_engine_available(Engine_Name) -> bool()
Tell if Engine_Name
is available.
peername(Compress_socket::Compress_Socket) -> {ok, {Address, Port}} | {error, posix()}
Returns the address and port for the other end of a connection.
recv(Compress_Socket) -> {ok, Orig_Packet} | {error, Reason}
Receive data over a compressed connection.
recv(Compress_socket::Compress_Socket, Timeout) -> {ok, Orig_Packet} | {error, Reason}
Receive data over a compressed connection.
recv_data(Compress_socket::Compress_Socket, Packet) -> {ok, Orig_Packet} | {error, Reason}
Uncompressed already received data.
register_engine(Name, Driver, Compress_Methods) -> ok
Add a new compression engine.
register_engine(Name, Driver_Path, Driver, Compress_Methods) -> ok
Add a new compression engine.
send(Compress_socket::Compress_Socket, Packet::Orig_Packet) -> ok | {error, Reason}
Send Orig_Packet
over a compressed connection.
setopts(Compress_socket::Compress_Socket, Options) -> ok | {error, posix()}
Sets one or more options for a socket.
sockname(Compress_socket::Compress_Socket) -> {ok, {Address, Port}} | {error, posix()}
Returns the local address and port number for a socket.
Generated by EDoc, Jan 21 2011, 01:43:51.