Lock Struct Reference

#include <Lock.h>

Overview

POSIX Threads locks.

Mediate access to a critical section by enforcing mutual exclusion.

Definition at line 42 of file Lock.h.

Inheritance diagram for Lock:

Properties
Object	object
	The superclass. More...
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class. More...

Methods
Class *	_Lock (void)
	The Lock archetype. More...
Lock *	init (Lock *self)
	Initializes this Lock. More...
void	lock (Lock *self)
	Acquire this lock, waiting indefinitely. More...
_Bool	tryLock (Lock *self)
	Attempt to acquire this lock immediately. More...
void	unlock (Lock *self)
	Release this Lock. More...
Methods inherited from Object
Class *	_Object (void)
	The Object archetype. More...
Object *	copy (const Object *self)
	Creates a shallow copy of this Object. More...
void	dealloc (Object *self)
	Frees all resources held by this Object. More...
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object. More...
_Bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object. More...
_Bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership. More...

Protected Attributes
LockInterface *	interface
	The interface. More...
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

Property Details

interface

LockInterface* Lock::interface

protected

The interface.

Definition at line 53 of file Lock.h.

object

Object Lock::object

The superclass.

Definition at line 47 of file Lock.h.

Method Details

_Lock()

Class * _Lock

(

void

)

The Lock archetype.

Returns

The Lock Class.

Definition at line 129 of file Lock.c.

                   {
    static Class *clazz;
    static Once once;
 
    do_once(&once, {
        clazz = _initialize(&(const ClassDef) {
            .name = "Lock",
            .superclass = _Object(),
            .instanceSize = sizeof(Lock),
            .interfaceOffset = offsetof(Lock, interface),
            .interfaceSize = sizeof(LockInterface),
            .initialize = initialize,
        });
    });
 
    return clazz;
}

init()

Lock * init

(

Lock *

self

)

Initializes this Lock.

Parameters

self

The Lock.

Returns

The initialized Lock, or NULL on error.

Definition at line 62 of file Lock.c.

                              {
 
    self = (Lock *) super(Object, self, init);
    if (self) {
 
        self->lock = calloc(1, sizeof(pthread_mutex_t));
        assert(self->lock);
 
        const int err = pthread_mutex_init(self->lock, NULL);
        assert(err == 0);
    }
 
    return self;
}

lock()

void lock

(

Lock *

self

)

Acquire this lock, waiting indefinitely.

Parameters

self

The Lock.

Definition at line 81 of file Lock.c.

                             {
 
    int err = pthread_mutex_lock(self->lock);
    assert(err == 0);
}

tryLock()

_Bool tryLock

(

Lock *

self

)

Attempt to acquire this lock immediately.

Parameters

self

The Lock.

Returns

true if the Lock was acquired, false otherwise.

Definition at line 91 of file Lock.c.

                                 {
 
    int err = pthread_mutex_trylock(self->lock);
    assert(err == 0 || err == EBUSY);
 
    return err == 0;
}

unlock()

void unlock

(

Lock *

self

)

Release this Lock.

Parameters

self

The Lock.

Definition at line 103 of file Lock.c.

                               {
 
    int err = pthread_mutex_unlock(self->lock);
    assert(err == 0);
}

---

The documentation for this struct was generated from the following files:

• Sources/Objectively/Lock.h
• Sources/Objectively/Lock.c