Phants Client for Redis™*
Public Member Functions | List of all members
XclaimOptions Class Reference

Public Member Functions

void SetIdle (int idle)
 
void ClearIdle ()
 
void SetTime (int time)
 
void ClearTime ()
 
void SetRetryCount (int retryCount)
 
void ClearRetryCount ()
 
void SetForce (bool force)
 
void SetJustid (bool justid)
 

Detailed Description

Options class used by the Xclaim() method.

Member Function Documentation

void ClearIdle ( )
inline

Clears/unsets the IDLE modifier.

The IDLE modifier will be omitted from the command.

void ClearRetryCount ( )
inline

Clears/unsets the RETRYCOUNT modifier.

The RETRYCOUNT modifier will be omitted from the command.

void ClearTime ( )
inline

Clears/unsets the TIME modifier.

The TIME modifier will be omitted from the command.

void SetForce ( bool  force)
inline

Sets or clears the FORCE modifier.

Parameters
forceA value of true includes the FORCE modifier, false omits it.
void SetIdle ( int  idle)
inline

Set the idle time of the message.

Parameters
idleThe idle time (relative to the current time), in milliseconds.
void SetJustid ( bool  justid)
inline

Sets or clears the JUSTID modifier.

Parameters
justidA value of true includes the JUSTID modifier, false omits it.
void SetRetryCount ( int  retryCount)
inline

Set the retry counter of the message.

Parameters
retryCountThe counter value to set.
void SetTime ( int  time)
inline

Set the idle time of the message.

Parameters
timeThe idle time (as a Unix time value), in milliseconds.

The documentation for this class was generated from the following file: