read_write_lock.c File Reference

#include <stdlib.h>
#include "FreeRTOS.h"
#include "semphr.h"
#include "read_write_lock.h"

Include dependency graph for read_write_lock.c:

Go to the source code of this file.

Data Structures
struct	RWLockPreferReader_t_
struct	RWLockPreferWriter_t_

Typedefs
typedef struct RWLockPreferReader_t_	RWLockPreferReader_t
typedef struct RWLockPreferWriter_t_	RWLockPreferWriter_t

Enumerations
enum	ReaderWriterLockType { RwPreferReader = 0x72656164, RwPreferWriter = 0x77726974 }

Functions
ReadWriteLock_t *	CreateReadWriteLockPreferReader (void)
ReadWriteLock_t *	CreateReadWriteLockPreferWriter (void)
void	FreeReadWriteLock (ReadWriteLock_t *lock)
void	ReaderLock (ReadWriteLock_t *lock)
void	ReaderUnlock (ReadWriteLock_t *lock)
void	WriterLock (ReadWriteLock_t *lock)
void	WriterUnlock (ReadWriteLock_t *lock)

Typedef Documentation

RWLockPreferReader_t

typedef struct RWLockPreferReader_t_ RWLockPreferReader_t

RWLockPreferWriter_t

typedef struct RWLockPreferWriter_t_ RWLockPreferWriter_t

Enumeration Type Documentation

ReaderWriterLockType

enum ReaderWriterLockType

Enumerator
RwPreferReader
RwPreferWriter

Definition at line 50 of file read_write_lock.c.

Function Documentation

CreateReadWriteLockPreferReader()

ReadWriteLock_t* CreateReadWriteLockPreferReader

(

void

)

Create a Reader/Writer lock that offers preference to all readers.

Returns

A handle to the lock, or NULL on failure.

Definition at line 132 of file read_write_lock.c.

CreateReadWriteLockPreferWriter()

ReadWriteLock_t* CreateReadWriteLockPreferWriter

(

void

)

Create a Reader/Writer lock that offers preference to all writers.

Returns

A handle to the lock, or NULL on failure.

Definition at line 198 of file read_write_lock.c.

FreeReadWriteLock()

void FreeReadWriteLock

(

ReadWriteLock_t *

lock

)

Free an already allocated Reader/Writer lock.

Parameters

lock	The lock you are freeing.

Definition at line 296 of file read_write_lock.c.

ReaderLock()

void ReaderLock

(

ReadWriteLock_t *

Lock

)

Lock as a Reader.

This allows you shared read only access to whatever is being protected by this lock.

Parameters

Lock	The lock you are taking.

Definition at line 321 of file read_write_lock.c.

ReaderUnlock()

void ReaderUnlock

(

ReadWriteLock_t *

Lock

)

Unlock as a Reader.

You should have already locked this using ReaderLock().

Parameters

Lock	The lock you are releasing.

Definition at line 359 of file read_write_lock.c.

WriterLock()

void WriterLock

(

ReadWriteLock_t *

Lock

)

Lock as a Writer.

This allows you exclusive read / write access to whatever is being protected by this lock.

Parameters

Lock	The lock you are taking.

Definition at line 395 of file read_write_lock.c.

WriterUnlock()

void WriterUnlock

(

ReadWriteLock_t *

Lock

)

Unlock as a Writer.

You should have already locked this using WriterLock().

Parameters

Lock	The lock you are releasing.

Definition at line 427 of file read_write_lock.c.