---
name: "ACE_Local_RLock"
section: "3"
platform: "linux"
package: "libace-doc"
version: "5.0.7-4"
release: "Debian 2.2 (Potato)"
platforms: ["linux"]
url: "https://new.carta.tech/ACE_Local_RLock"
---

# ACE\_Local\_RLock(3)

Class that acquires, renews, and releases a readers lock that is local to the process.

## NAME

ACE\_Local\_RLock -  Class that acquires, renews, and releases a readers lock that is local to the process.

## SYNOPSIS

```
#include <ace/Local_Tokens.h>
class ACE_Local_RLock : public ACE_Token_Proxy
{
  public:
    ACE_Local_RLock (
        const ASYS_TCHAR *token_name = 0,
        int ignore_deadlock = 0,
        int debug = 0
        );
    ~ACE_Local_RLock (void);
    void dump (void) const;
    virtual int type (void) const;
    virtual ACE_Token_Proxy *clone (void) const;
  protected:
    virtual ACE_Tokens *create_token (const ASYS_TCHAR *name);
};
```

## DESCRIPTION

This file contains definitions for the following classes:

public:\
   7\. ACE\_Token\_Proxy\
   8\. ACE\_Null\_Token : public ACE\_Token\_Proxy\
   9\. ACE\_Local\_Mutex : public ACE\_Token\_Proxy\
   \*. ACE\_Local\_RLock : public ACE\_Local\_Mutex\
   &. ACE\_Local\_WLock : public ACE\_Local\_Mutex private:\
   1\. ACE\_TOKEN\_CONST\
   3\. ACE\_TPQ\_Entry\
   b. ACE\_TSS\_TPQ\_Entry\
   c. ACE\_TPQ\_Iterator\
   4\. ACE\_Token\_Proxy\_Queue\
   5\. ACE\_Tokens\
   6\. ACE\_Mutex\_Token : public ACE\_Tokens\
   12\. ACE\_RW\_Token : public ACE\_Tokens\
   a. ACE\_Token\_Name

 Note that the locking classes defined in this file are \*not\*\
  intended to be used as general-purpose synchronization\
  mechanisms, such as mutexes or semaphores.  Instead, you should\
  use the ACE\_Recursive\_Thread\_Mutex, ACE\_Thread\_Mutex,\
  ACE\_Thread\_Semaphore, etc., that are defined in\
  $ACE\_ROOT/ace/Synch.h and $ACE\_ROOT/ace/Synch\_T.h or the\
  ACE\_Token that's defined in $ACE\_ROOT/ace/Token.h.

## Initialization and termination.

```
ACE_Local_RLock (
    const ASYS_TCHAR *token_name = 0,
    int ignore_deadlock = 0,
    int debug = 0
    );
```

token\_name uniquely id's the token. ignore\_deadlock will allow deadlock to occur (useful for testing).  debug prints a bunch of messages.

```
~ACE_Local_RLock (void);
```

Destructor

```
void dump (void) const;
```

Dump the state of the class.

```
virtual int type (void) const;
```

Returns ACE\_RW\_Token::RLOCK.

```
virtual ACE_Token_Proxy *clone (void) const;
```

Return deep copy.

## AUTHOR

Karl-Heinz Dorn kdorn@erlh.siemens.de, Douglas C. Schmidt schmidt@cs.wustl.edu, and Tim Harrison harrison@cs.wustl.edu

## LIBRARY

ace