---
name: "ACE_Guard"
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_Guard"
---

# ACE\_Guard(3)

This data structure is meant to be used within a method or function... It performs automatic aquisition and release of a parameterized synchronization object ACE\_LOCK.

## NAME

ACE\_Guard -  This data structure is meant to be used within a method or function...  It performs automatic aquisition and release of a parameterized synchronization object ACE\_LOCK.

## SYNOPSIS

```
#include <ace/Synch_T.h>
template<class ACE_LOCK>
class ACE_Guard
{
  public:
    ACE_Guard (ACE_LOCK &l);
    ACE_Guard (ACE_LOCK &l, int block);
    ~ACE_Guard (void);
    int acquire (void);
    int tryacquire (void);
    int release (void);
    int locked (void);
    int remove (void);
    void dump (void) const;
  protected:
    inline ACE_Guard (ACE_LOCK *lock);
    ACE_LOCK *lock_;
    int owner_;
  private:
    inline ACE_UNIMPLEMENTED_FUNC (
        void operator= (const ACE_Guard<ACE_LOCK> &)
        );
};
```

## DESCRIPTION

The ACE\_LOCK class given as an actual parameter must provide at the very least the acquire, tryacquire, release, and remove methods.

## Initialization and termination methods.

```
ACE_Guard (ACE_LOCK &l);
```

```
ACE_Guard (ACE_LOCK &l, int block);
```

Implicitly and automatically acquire (or try to acquire) the lock.

```
~ACE_Guard (void);
```

Implicitly release the lock.

## Lock accessors.

```
int acquire (void);
```

Explicitly acquire the lock.

```
int tryacquire (void);
```

Conditionally acquire the lock (i.e., won't block).

```
int release (void);
```

Explicitly release the lock, but only if it is held!

## Utility methods.

```
int locked (void);
```

1 if locked, 0 if couldn't acquire the lock (errno will contain the reason for this).

```
int remove (void);
```

Explicitly remove the lock.

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

Dump the state of an object.

ACE\_ALLOC\_HOOK\_DECLARE; Declare the dynamic allocation hooks.

## Prevent assignment and initialization.

```
inline ACE_UNIMPLEMENTED_FUNC (
    void operator= (const ACE_Guard<ACE_LOCK> &)
    );
```

## AUTHOR

Doug Schmidt

## LIBRARY

ace