libflom: FLoM (Free Lock Manager) client library

Public Member Functions | List of all members
flom::FlomHandle Class Reference

#include <FlomHandle.hh>

Public Member Functions

 FlomHandle ()
 
int getDiscoveryAttempts ()
 
int getDiscoveryTimeout ()
 
int getDiscoveryTtl ()
 
string getLockedElement ()
 
const char * getLockedElementAsCStr ()
 
flom_lock_mode_t getLockMode ()
 
string getMulticastAddress ()
 
const char * getMulticastAddressAsCStr ()
 
int getMulticastPort ()
 
string getNetworkInterface ()
 
const char * getNetworkInterfaceAsCStr ()
 
int getResourceCreate ()
 
int getResourceIdleLifespan ()
 
string getResourceName ()
 
const char * getResourceNameAsCStr ()
 
int getResourceQuantity ()
 
int getResourceTimeout ()
 
string getSocketName ()
 
const char * getSocketNameAsCStr ()
 
string getTlsCaCertificate ()
 
const char * getTlsCaCertificateAsCStr ()
 
string getTlsCertificate ()
 
const char * getTlsCertificateAsCStr ()
 
int getTlsCheckPeerId ()
 
string getTlsPrivateKey ()
 
const char * getTlsPrivateKeyAsCStr ()
 
string getTraceFilename ()
 
const char * getTraceFilenameAsCStr ()
 
string getUnicastAddress ()
 
const char * getUnicastAddressAsCStr ()
 
int getUnicastPort ()
 
int lock ()
 
int setDiscoveryAttempts (int value)
 
int setDiscoveryTimeout (int value)
 
int setDiscoveryTtl (int value)
 
int setLockMode (flom_lock_mode_t value)
 
int setMulticastAddress (const char *value)
 
int setMulticastAddress (const string &value)
 
int setMulticastPort (int value)
 
int setNetworkInterface (const char *value)
 
int setNetworkInterface (const string &value)
 
int setResourceCreate (int value)
 
int setResourceIdleLifespan (int value)
 
int setResourceName (const char *value)
 
int setResourceName (const string &value)
 
int setResourceQuantity (int value)
 
int setResourceTimeout (int value)
 
int setSocketName (const char *value)
 
int setSocketName (const string &value)
 
int setTlsCaCertificate (const char *value)
 
int setTlsCaCertificate (const string &value)
 
int setTlsCertificate (const char *value)
 
int setTlsCertificate (const string &value)
 
int setTlsCheckPeerId (int value)
 
int setTlsPrivateKey (const char *value)
 
int setTlsPrivateKey (const string &value)
 
int setTraceFilename (const char *value)
 
int setTraceFilename (const string &value)
 
int setUnicastAddress (const char *value)
 
int setUnicastAddress (const string &value)
 
int setUnicastPort (int value)
 
int unlock ()
 
int unlockRollback ()
 
 ~FlomHandle ()
 

Detailed Description

This class provides C++ abstraction to C flom_handle_t type

Definition at line 78 of file FlomHandle.hh.

Constructor & Destructor Documentation

flom::FlomHandle::FlomHandle ( )
inline

Definition at line 86 of file FlomHandle.hh.

References FLOM_RC_OK, and flom_strerror().

flom::FlomHandle::~FlomHandle ( )
inline

Definition at line 95 of file FlomHandle.hh.

References FLOM_RC_OK, and flom_strerror().

Member Function Documentation

int flom::FlomHandle::getDiscoveryAttempts ( )
inline

Get the maximum number of attempts that will be tryed during auto-discovery phase using UDP/IP multicast (see getMulticastAddress, getMulticastPort). The current value can be altered using method setDiscoveryAttempts

Returns
the current value

Definition at line 169 of file FlomHandle.hh.

int flom::FlomHandle::getDiscoveryTimeout ( )
inline

Get the number of milliseconds between two consecutive attempts that will be tryed during auto-discovery phase using UDP/IP multicast (see getMulticastAddress, getMulticastPort). The current value can be altered using method setDiscoveryTimeout

Returns
the current value

Definition at line 193 of file FlomHandle.hh.

int flom::FlomHandle::getDiscoveryTtl ( )
inline

Get the UDP/IP multicast TTL parameter used during auto-discovery phase; for a definition of the parameter, see http://www.tldp.org/HOWTO/Multicast-HOWTO-2.html . The current value can be altered using method setDiscoveryTtl

Returns
the current value

Definition at line 216 of file FlomHandle.hh.

string flom::FlomHandle::getLockedElement ( )
inline

Get the name of the locked element if the resource is of type set.

Note 1: this method can be used only after lock and before unlock Note 2: this method can be used only when locking a resource of type "resource set"

Note 3: the return string must copied as soon as possible to a different place because it's a dynamic string removed by unlock

Returns
the name of the locked element

Definition at line 157 of file FlomHandle.hh.

const char* flom::FlomHandle::getLockedElementAsCStr ( )
inline

Get the name of the locked element if the resource is of type set.

Note 1: this method can be used only after lock and before unlock Note 2: this method can be used only when locking a resource of type "resource set"

Note 3: the return string must copied as soon as possible to a different place because it's a dynamic string removed by unlock

Returns
the name of the locked element

Definition at line 142 of file FlomHandle.hh.

flom_lock_mode_t flom::FlomHandle::getLockMode ( )
inline

Get lock mode property: how a simple or hierarchical resource will be locked when method lock is called; FLoM supports the same lock mode semantic proposed by DLM, see http://en.wikipedia.org/wiki/Distributed_lock_manager#Lock_modes for a detailed explanation . The current value can be altered using method setLockMode

Returns
the current value

Definition at line 240 of file FlomHandle.hh.

string flom::FlomHandle::getMulticastAddress ( )
inline

Get the multicast address: the IP address (or a network name that the system can resolve) of the IP multicast group that must be contacted to reach FLoM daemon (server) using UDP/IP; see also getMulticastPort. The current value can be altered using method setMulticastAddress.

Returns
the current value as a standard C++ string

Definition at line 276 of file FlomHandle.hh.

const char* flom::FlomHandle::getMulticastAddressAsCStr ( )
inline

Get the multicast address: the IP address (or a network name that the system can resolve) of the IP multicast group that must be contacted to reach FLoM daemon (server) using UDP/IP; see also getMulticastPort. The current value can be altered using method setMulticastAddress.

Returns
the current value as a null terminated C string

Definition at line 265 of file FlomHandle.hh.

int flom::FlomHandle::getMulticastPort ( )
inline

Get the UDP/IP multicast port that must be used to contact the FLoM daemon (server) using UDP/IP; see also getMulticastAddress. The current value can be altered using method setMulticastPort.

Returns
the current value

Definition at line 311 of file FlomHandle.hh.

string flom::FlomHandle::getNetworkInterface ( )
inline

Get the network interface that must be used for IPv6 link local addresses The current value can be altered using method setNetworkInterface.

Returns
the current value as a C++ standard string

Definition at line 341 of file FlomHandle.hh.

const char* flom::FlomHandle::getNetworkInterfaceAsCStr ( )
inline

Get the network interface that must be used for IPv6 link local addresses The current value can be altered using method setNetworkInterface.

Returns
the current value as a C null terminated string

Definition at line 332 of file FlomHandle.hh.

int flom::FlomHandle::getResourceCreate ( )
inline

Get "resource create" boolean property: it specifies if method lock can create a new resource when the specified one is not defined; the default value is TRUE. The current value can be altered using method setResourceCreate.

Returns
the current value

Definition at line 374 of file FlomHandle.hh.

int flom::FlomHandle::getResourceIdleLifespan ( )
inline

Get "resource idle lifespan" property: it specifies how many milliseconds a resource will be kept after the last locker released it; the expiration is necessary to avoid useless resource allocation. The current value can be altered using method setResourceIdleLifespan.

Returns
the current value

Definition at line 398 of file FlomHandle.hh.

string flom::FlomHandle::getResourceName ( )
inline

Get the resource name: the name of the resource that can be locked and unlocked using lock and unlock methods. The current value can be altered using method setResourceName.

Returns
the current value as a C++ standard string

Definition at line 428 of file FlomHandle.hh.

const char* flom::FlomHandle::getResourceNameAsCStr ( )
inline

Get the resource name: the name of the resource that can be locked and unlocked using lock and unlock methods. The current value can be altered using method setResourceName.

Returns
the current value as a null terminated C string

Definition at line 420 of file FlomHandle.hh.

int flom::FlomHandle::getResourceQuantity ( )
inline

Get "resource quantity" property: the number of units that will be locked and unlocked using lock and unlock methods. The current value can be altered using method setResourceQuantity. NOTE: this property applies to "numeric resources" only.

Returns
the current value

Definition at line 468 of file FlomHandle.hh.

int flom::FlomHandle::getResourceTimeout ( )
inline

Get "resource timeout" property: how long a lock operation (see lock) will wait if the resource is locked by another requester. The current value can be altered using method setResourceTimeout.

Returns
the current value:
0: no wait
>0: maximum number of milliseconds to wait
<0: unlimited wait

Definition at line 494 of file FlomHandle.hh.

string flom::FlomHandle::getSocketName ( )
inline

Get the socket name: the AF_LOCAL/AF_UNIX socket name that must be used to contact a local FLoM daemon (server). The current value can be altered using method setSocketName.

Returns
the current value as a C++ standard string

Definition at line 526 of file FlomHandle.hh.

const char* flom::FlomHandle::getSocketNameAsCStr ( )
inline

Get the socket name: the AF_LOCAL/AF_UNIX socket name that must be used to contact a local FLoM daemon (server). The current value can be altered using method setSocketName.

Returns
the current value as a C null terminated string

Definition at line 518 of file FlomHandle.hh.

string flom::FlomHandle::getTlsCaCertificate ( )
inline

Get the TLS CA certificate file name. The current value can be altered using method setTlsCaCertificate.

Returns
the current value as a C++ standard string

Definition at line 744 of file FlomHandle.hh.

const char* flom::FlomHandle::getTlsCaCertificateAsCStr ( )
inline

Get the TLS CA certificate file name. The current value can be altered using method setTlsCaCertificate.

Returns
the current value as a C null terminated string

Definition at line 736 of file FlomHandle.hh.

string flom::FlomHandle::getTlsCertificate ( )
inline

Get the TLS certificate file name. The current value can be altered using method setTlsCertificate.

Returns
the current value as a C++ standard string

Definition at line 670 of file FlomHandle.hh.

const char* flom::FlomHandle::getTlsCertificateAsCStr ( )
inline

Get the TLS certificate file name. The current value can be altered using method setTlsCertificate.

Returns
the current value as a C null terminated string

Definition at line 662 of file FlomHandle.hh.

int flom::FlomHandle::getTlsCheckPeerId ( )
inline

Get "TLS check peer ID" boolean property The current value can be altered using method setTlsCheckPeerId.

Returns
the current value

Definition at line 774 of file FlomHandle.hh.

string flom::FlomHandle::getTlsPrivateKey ( )
inline

Get the TLS private key file name. The current value can be altered using method setTlsPrivateKey.

Returns
the current value as a C++ standard string

Definition at line 707 of file FlomHandle.hh.

const char* flom::FlomHandle::getTlsPrivateKeyAsCStr ( )
inline

Get the TLS private key file name. The current value can be altered using method setTlsPrivateKey.

Returns
the current value as a C null terminated string

Definition at line 699 of file FlomHandle.hh.

string flom::FlomHandle::getTraceFilename ( )
inline

Get the trace filename: the name (absolute or relative path) used by libflom (FLoM client library) to record trace messages. The current value can be altered using method setTraceFilename.

Returns
the current value as a C++ standard string

Definition at line 563 of file FlomHandle.hh.

const char* flom::FlomHandle::getTraceFilenameAsCStr ( )
inline

Get the trace filename: the name (absolute or relative path) used by libflom (FLoM client library) to record trace messages. The current value can be altered using method setTraceFilename.

Returns
the current value as a C null terminated string

Definition at line 555 of file FlomHandle.hh.

string flom::FlomHandle::getUnicastAddress ( )
inline

Get the unicast address: the IP address (or a network name that the system can resolve) of the host that must be contacted to reach FLoM daemon (server) using TCP/IP; see also getUnicastPort. The current value can be altered using method setUnicastAddress.

Returns
the current value as a C++ standard string

Definition at line 608 of file FlomHandle.hh.

const char* flom::FlomHandle::getUnicastAddressAsCStr ( )
inline

Get the unicast address: the IP address (or a network name that the system can resolve) of the host that must be contacted to reach FLoM daemon (server) using TCP/IP; see also getUnicastPort. The current value can be altered using method setUnicastAddress.

Returns
the current value as a C null terminated string

Definition at line 597 of file FlomHandle.hh.

int flom::FlomHandle::getUnicastPort ( )
inline

Get the TCP/IP unicast port that must be used to contact the FLoM daemon (server) using TCP/IP; see also getUnicastAddress. The current value can be altered using method setUnicastPort.

Returns
the current value

Definition at line 643 of file FlomHandle.hh.

int flom::FlomHandle::lock ( )
inline

Locks the (logical) resource linked to this handle; the resource MUST be unlocked using method unlock when the lock condition is no more necessary.

Returns
a reason code (see file flom_errors.h)

Definition at line 111 of file FlomHandle.hh.

int flom::FlomHandle::setDiscoveryAttempts ( int  value)
inline

Set the maximum number of attempts that will be tryed during auto-discovery phase using UDP/IP multicast (see setMulticastAddress, setMulticastPort). The current value can be inspected using method getDiscoveryAttempts

Parameters
value(Input): the new value
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 181 of file FlomHandle.hh.

int flom::FlomHandle::setDiscoveryTimeout ( int  value)
inline

Set the number of milliseconds between two consecutive attempts that will be tryed during auto-discovery phase using UDP/IP multicast (see setMulticastAddress, setMulticastPort). The current value can be inspected using method getDiscoveryTimeout.

Parameters
value(Input): the new value
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 206 of file FlomHandle.hh.

int flom::FlomHandle::setDiscoveryTtl ( int  value)
inline

Set the UDP/IP multicast TTL parameter used during auto-discovery phase; for a definition of the parameter, see http://www.tldp.org/HOWTO/Multicast-HOWTO-2.html . The current value can be inspected using method getDiscoveryTtl.

Parameters
value(Input): the new value
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 228 of file FlomHandle.hh.

int flom::FlomHandle::setLockMode ( flom_lock_mode_t  value)
inline

Set lock mode property: how a simple or hierarchical resource will be locked when method lock is called; FLoM supports the same lock mode semantic proposed by DLM, see http://en.wikipedia.org/wiki/Distributed_lock_manager#Lock_modes for a detailed explanation . The current value can be inspected using method getLockMode

Parameters
value(Input): the new value
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 253 of file FlomHandle.hh.

int flom::FlomHandle::setMulticastAddress ( const char *  value)
inline

Set the multicast address: the IP address (or a network name that the system can resolve) of the IP multicast group that must be contacted to reach FLoM daemon (server) using UDP/IP; see also setMulticastPort. The current value can be inspected using method getMulticastAddress.

Parameters
value(Input): the new value (C null terminated string)
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 290 of file FlomHandle.hh.

int flom::FlomHandle::setMulticastAddress ( const string &  value)
inline

Set the multicast address: the IP address (or a network name that the system can resolve) of the IP multicast group that must be contacted to reach FLoM daemon (server) using UDP/IP; see also setMulticastPort. The current value can be inspected using method getMulticastAddress.

Parameters
value(Input): the new value (C++ standard string)
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 302 of file FlomHandle.hh.

int flom::FlomHandle::setMulticastPort ( int  value)
inline

Set the UDP/IP multicast port that must be used to contact the FLoM daemon (server) using UDP/IP; see also setMulticastAddress. The current value can be inspected using method getMulticastPort.

Parameters
value(Input): the new value
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 322 of file FlomHandle.hh.

int flom::FlomHandle::setNetworkInterface ( const char *  value)
inline

Set the network interface that must be used for IPv6 link local addresses The current value can be inspected using method getNetworkInterface.

Parameters
value(Input): the new value (C null terminted string)
Returns
a reason code

Definition at line 353 of file FlomHandle.hh.

int flom::FlomHandle::setNetworkInterface ( const string &  value)
inline

Set the network interface that must be used for IPv6 link local addresses The current value can be inspected using method getNetworkInterface.

Parameters
value(Input): the new value (C++ standard string)
Returns
a reason code

Definition at line 363 of file FlomHandle.hh.

int flom::FlomHandle::setResourceCreate ( int  value)
inline

Set "resource create" boolean property: it specifies if method lock can create a new resource when the specified one is not defined. The current value can be inspected using method getResourceCreate.

Parameters
value(Input): the new value
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 386 of file FlomHandle.hh.

int flom::FlomHandle::setResourceIdleLifespan ( int  value)
inline

Set "resource idle lifespan" property: it specifies how many milliseconds a resource will be kept after the last locker released it; the expiration is necessary to avoid useless resource allocation. The current value can be inspected using method getResourceIdleLifespan.

Parameters
value(Input): the new value
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 411 of file FlomHandle.hh.

int flom::FlomHandle::setResourceName ( const char *  value)
inline

Set the resource name: the name of the resource that can be locked and unlocked using lock and unlock methods. The current value can be inspected using method getResourceName. NOTE: the resource type is determined by its name; take a look to flom command man page (-r, –resource-name option) for an explanation of the resource name grammar.

Parameters
value(Input): the new value (C null terminated string)
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 443 of file FlomHandle.hh.

int flom::FlomHandle::setResourceName ( const string &  value)
inline

Set the resource name: the name of the resource that can be locked and unlocked using lock and unlock methods. The current value can be inspected using method getResourceName. NOTE: the resource type is determined by its name; take a look to flom command man page (-r, –resource-name option) for an explanation of the resource name grammar.

Parameters
value(Input): the new value (C++ standard string)
Returns
a reason code (see file flom_errors.h)
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 457 of file FlomHandle.hh.

int flom::FlomHandle::setResourceQuantity ( int  value)
inline

Set "resource quantity" property: the number of units that will be locked and unlocked using lock and unlock methods. The current value can be inspected using method getResourceQuantity. NOTE: this property applies to "numeric resources" only.

Parameters
value(Input): the new value
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 480 of file FlomHandle.hh.

int flom::FlomHandle::setResourceTimeout ( int  value)
inline

Set "resource timeout" property: how long a lock operation (see lock) will wait if the resource is locked by another requester. The current value can be inspected using method getResourceTimeout.

Parameters
value(Input): the new value:
0: no wait
>0: maximum number of milliseconds to wait
<0: unlimited wait
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 509 of file FlomHandle.hh.

int flom::FlomHandle::setSocketName ( const char *  value)
inline

Set the socket name: the AF_LOCAL/AF_UNIX socket name that must be used to contact a local FLoM daemon (server). The current value can be inspected using method getSocketName.

Parameters
value(Input): the new value (C null terminated string)
Returns
a reason code (see file flom_errors.h)

Definition at line 537 of file FlomHandle.hh.

int flom::FlomHandle::setSocketName ( const string &  value)
inline

Set the socket name: the AF_LOCAL/AF_UNIX socket name that must be used to contact a local FLoM daemon (server). The current value can be inspected using method getSocketName.

Parameters
value(Input): the new value (C++ standard string)
Returns
a reason code (see file flom_errors.h)

Definition at line 546 of file FlomHandle.hh.

int flom::FlomHandle::setTlsCaCertificate ( const char *  value)
inline

Set the TLS CA certificate name. The current value can be inspected using method getTlsCaCertificate.

Parameters
value(Input): the new value (C null terminted string)
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 755 of file FlomHandle.hh.

int flom::FlomHandle::setTlsCaCertificate ( const string &  value)
inline

Set the TLS CA certificate name. The current value can be inspected using method getTlsCaCertificate.

Parameters
value(Input): the new value (C++ standard string)
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 764 of file FlomHandle.hh.

int flom::FlomHandle::setTlsCertificate ( const char *  value)
inline

Set the TLS certificate name. The current value can be inspected using method getTlsCertificate.

Parameters
value(Input): the new value (C null terminted string)
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 681 of file FlomHandle.hh.

int flom::FlomHandle::setTlsCertificate ( const string &  value)
inline

Set the TLS certificate name. The current value can be inspected using method getTlsCertificate.

Parameters
value(Input): the new value (C++ standard string)
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 690 of file FlomHandle.hh.

int flom::FlomHandle::setTlsCheckPeerId ( int  value)
inline

Set "TLS check peer ID" boolean property The current value can be inspected using method getTlsCheckPeerId.

Parameters
value(Input): the new value
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 784 of file FlomHandle.hh.

int flom::FlomHandle::setTlsPrivateKey ( const char *  value)
inline

Set the TLS private key name. The current value can be inspected using method getTlsPrivateKey.

Parameters
value(Input): the new value (C null terminted string)
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 718 of file FlomHandle.hh.

int flom::FlomHandle::setTlsPrivateKey ( const string &  value)
inline

Set the TLS private key name. The current value can be inspected using method getTlsPrivateKey.

Parameters
value(Input): the new value (C++ standard string)
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 727 of file FlomHandle.hh.

int flom::FlomHandle::setTraceFilename ( const char *  value)
inline

Set the trace filename: the name (absolute or relative path) used by libflom (FLoM client library) to record trace messages. The current value can be inspected using method getTraceFilename.

Parameters
value(Input): the new value (C null terminated string)
Returns
FLOM_RC_OK

Definition at line 575 of file FlomHandle.hh.

int flom::FlomHandle::setTraceFilename ( const string &  value)
inline

Set the trace filename: the name (absolute or relative path) used by libflom (FLoM client library) to record trace messages. The current value can be inspected using method getTraceFilename.

Parameters
value(Input): the new value (C++ standard string)
Returns
FLOM_RC_OK

Definition at line 585 of file FlomHandle.hh.

int flom::FlomHandle::setUnicastAddress ( const char *  value)
inline

Set the unicast address: the IP address (or a network name that the system can resolve) of the host that must be contacted to reach FLoM daemon (server) using TCP/IP; see also setUnicastPort. The current value can be inspected using method getUnicastAddress.

Parameters
value(Input): the new value (C null terminted string)
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 622 of file FlomHandle.hh.

int flom::FlomHandle::setUnicastAddress ( const string &  value)
inline

Set the unicast address: the IP address (or a network name that the system can resolve) of the host that must be contacted to reach FLoM daemon (server) using TCP/IP; see also setUnicastPort. The current value can be inspected using method getUnicastAddress.

Parameters
value(Input): the new value (C++ standard string)
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 634 of file FlomHandle.hh.

int flom::FlomHandle::setUnicastPort ( int  value)
inline

Set the TCP/IP unicast port that must be used to contact the FLoM daemon (server) using TCP/IP; see also setUnicastAddress. The current value can be inspected using method getUnicastPort.

Parameters
value(Input): the new value
Returns
FLOM_RC_OK or FLOM_RC_API_IMMUTABLE_HANDLE

Definition at line 653 of file FlomHandle.hh.

int flom::FlomHandle::unlock ( )
inline

Unlocks the (logical) resource linked to this handle; the resource MUST be previously locked using method lock

Returns
a reason code (see file flom_errors.h)

Definition at line 118 of file FlomHandle.hh.

int flom::FlomHandle::unlockRollback ( )
inline

Unlocks the (logical) resource linked to this handle and rollback the transactional resource state; the resource MUST be previously locked using method lock . This method should be used only with transactional resources, for example: transactional unique sequences

Returns
a reason code (see file flom_errors.h)

Definition at line 128 of file FlomHandle.hh.

The documentation for this class was generated from the following file:
Copyright © 2013-2020, Christian Ferrari tiian@users.sourceforge.net