FieldsMethodsMember Objects1. Fields
peerMaxConnections
| Function name |
Function signature |
| listener_peerMaxConnections_set |
int listener_peerMaxConnections_set (object:listener obj, int value) |
|
This function sets the maximum number of simultaneous connections from a single client. Returns 0 on succes, -1 on failure
|
| listener_peerMaxConnections_get |
int listener_peerMaxConnections_get (object:listener obj) |
|
This function gets the maximum number of simultaneous connection allowed for a single client (peer)
|
peerTimeInterval
| Function name |
Function signature |
| listener_peerTimeInterval_set |
int listener_peerTimeInterval_set (object:listener obj, int value) |
|
This function sets the peer_time_interval parameter (in seconds)
|
| listener_peerTimeInterval_get |
int listener_peerTimeInterval_get (object:listener obj) |
|
This function returns the peer_time_interval value (in seconds)
|
peerMaxIntervalConnections
| Function name |
Function signature |
| listener_peerMaxIntervalConnections_get |
int listener_peerMaxIntervalConnections_get (object:listener obj) |
|
This function returns the maximum number of connections for a single peer in the peer_time_interval
|
| listener_peerMaxIntervalConnections_set |
int listener_peerMaxIntervalConnections_set (object:listener obj, int value) |
|
This function sets the maximum number of connections to be allowed for a single client in peer_time_interval seconds
|
sslEnable
| Function name |
Function signature |
| listener_sslEnable_get |
int listener_sslEnable_get (object:listener obj) |
|
This function returns 1 of the function has ssl enabled and 0 if not
|
| listener_sslEnable_set |
int listener_sslEnable_set (object:listener obj, int value) |
|
This function enables ssl if the 'value' parame
|
maxIntervalConnections
| Function name |
Function signature |
| listener_maxIntervalConnections_set |
int listener_maxIntervalConnections_set (object:listener obj, int value) |
|
This function sets the maximum number of connection to be allowed in time_interval seconds. Returns 0 on succes, -1 on failure
|
| listener_maxIntervalConnections_get |
int listener_maxIntervalConnections_get (object:listener obj) |
|
This function gets the maximum number of connections allowed in a time interval
|
idleTimeout
| Function name |
Function signature |
| listener_idleTimeout_set |
int listener_idleTimeout_set (object:listener obj, int value) |
|
This function sets the idle time interval after which the connection is interrupted. Returns 0 on succes, -1 on failure
|
| listener_idleTimeout_get |
int listener_idleTimeout_get (object:listener obj) |
|
This function returns the idle time interval (in seconds) after which the connetion is iterrupted
|
maxConnections
| Function name |
Function signature |
| listener_maxConnections_get |
int listener_maxConnections_get (object:listener obj) |
|
This function returns the maximum number of number of simultaneous connections allowed on this listener
|
| listener_maxConnections_set |
int listener_maxConnections_set (object:listener obj, int value) |
|
This function sets the maximum number of simulataneous connections allowed on the listener. Returns 0 on succes, -1 on failure
|
timeInterval
| Function name |
Function signature |
| listener_timeInterval_get |
int listener_timeInterval_get (object:listener obj) |
|
This function gets the the time interval (in seconds) in which the max_interval_connection are allowed
|
| listener_timeInterval_set |
int listener_timeInterval_set (object:listener obj, int value) |
|
This function sets the time_interval parameter to be used by the listener_maxConnections_set function. Returns 0 on succes, -1 on failure
|
enable
| Function name |
Function signature |
| listener_enable_get |
int listener_enable_get (object:listener obj) |
|
This function returns 1 if the listener is enabled and 0 otherwise
|
| listener_enable_set |
int listener_enable_set (object:listener obj, int value) |
|
This function enables the listener, if the 'value' parameter is 1, or disables it, if the 'value' is 0
|
address
| Function name |
Function signature |
| listener_address_set |
int listener_address_set (object:listener obj, string value) |
|
This function sets the address of the listener. Returns 0 on succes, -1 on failure
|
| listener_address_get |
string listener_address_get (object:listener obj) |
|
This function returns the address of the listener, like "127.0.0.1:25".
|
2. Methods
| Function name |
Function signature |
| listener_create |
object:listener listener_create () |
| listener_destroy |
int listener_destroy (void* data) |
| listener_save |
int listener_save (object:listener data, object:session session) |
|
This function saves a listener object. Returns 0 on succes, -1 on failure
|
| listener_load |
int listener_load (object:listener data, object:session session) |
3. Member Objects
listeners
Functions that apply to member object:
| Function name |
Function signature |
| imap_listeners_get |
object:listeners imap_listeners_get (object:imap imap, object:session s) |
|
This function returns the listener list of this service
|
