Package org.gnome.glib

Class RWLock

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.glib.RWLock

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class RWLock
extends ProxyInstance

The GRWLock struct is an opaque data structure to represent a reader-writer lock. It is similar to a GMutex in that it allows multiple threads to coordinate access to a shared resource.

The difference to a mutex is that a reader-writer lock discriminates between read-only ('reader') and full ('writer') access. While only one thread at a time is allowed write access (by holding the 'writer' lock via g_rw_lock_writer_lock()), multiple threads can gain simultaneous read-only access (by holding the 'reader' lock via g_rw_lock_reader_lock()).

It is unspecified whether readers or writers have priority in acquiring the lock when a reader already holds the lock and a writer is queued to acquire it.

Here is an example for an array with access functions:

  GRWLock lock;
   GPtrArray *array;

   gpointer
   my_array_get (guint index)
   {
     gpointer retval = NULL;

     if (!array)
       return NULL;

     g_rw_lock_reader_lock (&lock);
     if (index < array->len)
       retval = g_ptr_array_index (array, index);
     g_rw_lock_reader_unlock (&lock);

     return retval;
   }

   void
   my_array_set (guint index, gpointer data)
   {
     g_rw_lock_writer_lock (&lock);

     if (!array)
       array = g_ptr_array_new ();

     if (index >= array->len)
       g_ptr_array_set_size (array, index+1);
     g_ptr_array_index (array, index) = data;

     g_rw_lock_writer_unlock (&lock);
   }
  

This example shows an array which can be accessed by many readers (the my_array_get() function) simultaneously, whereas the writers (the my_array_set() function) will only be allowed one at a time and only if no readers currently access the array. This is because of the potentially dangerous resizing of the array. Using these functions is fully multi-thread safe now.

If a GRWLock is allocated in static storage then it can be used without initialisation. Otherwise, you should call g_rw_lock_init() on it and g_rw_lock_clear() when done.

A GRWLock should only be accessed with the g_rw_lock_ functions.

Since:

2.32

Constructor Summary

Constructors

Constructor	Description
RWLock()	Allocate a new RWLock.
RWLock(Arena arena)	Allocate a new RWLock.
RWLock(MemorySegment address)	Create a RWLock proxy instance for the provided memory address.
RWLock(MemorySegment p, int[] i)	Allocate a new RWLock with the fields set to the provided values.
RWLock(MemorySegment p, int[] i, Arena arena)	Allocate a new RWLock with the fields set to the provided values.

Method Summary

Modifier and Type	Method	Description
void	clear()	Frees the resources allocated to a lock with g_rw_lock_init().
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
void	init()	Initializes a GRWLock so that it can be used.
void	readerLock()	Obtain a read lock on rwLock. If another thread currently holds the write lock on rwLock, the current thread will block until the write lock was (held and) released.
boolean	readerTrylock()	Tries to obtain a read lock on this RWLock and returns true if the read lock was successfully obtained.
void	readerUnlock()	Release a read lock on rwLock.
@org.jspecify.annotations.Nullable int @Nullable []	readI()	Read the value of the field i.
MemorySegment	readP()	Read the value of the field p.
void	writeI(@org.jspecify.annotations.Nullable int @Nullable [] i, Arena _arena)	Write a value in the field i.
void	writeP(MemorySegment p)	Write a value in the field p.
void	writerLock()	Obtain a write lock on rwLock. If another thread currently holds a read or write lock on rwLock, the current thread will block until all other threads have dropped their locks on rwLock.
boolean	writerTrylock()	Tries to obtain a write lock on rwLock. If another thread currently holds a read or write lock on rwLock, it immediately returns false.
void	writerUnlock()	Release a write lock on rwLock.

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RWLock

public RWLock(MemorySegment address)

Create a RWLock proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

RWLock

public RWLock(Arena arena)

Allocate a new RWLock.

Parameters:

arena - to control the memory allocation scope

RWLock

public RWLock()

Allocate a new RWLock. The memory is allocated with Arena.ofAuto().

RWLock

public RWLock(MemorySegment p,
 int[] i,
 Arena arena)

Allocate a new RWLock with the fields set to the provided values.

Parameters:

p - value for the field p

i - value for the field i

arena - to control the memory allocation scope

RWLock

public RWLock(MemorySegment p,
 int[] i)

Allocate a new RWLock with the fields set to the provided values. The memory is allocated with Arena.ofAuto().

Parameters:

p - value for the field p

i - value for the field i

Method Details

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readP

public MemorySegment readP()

Read the value of the field p.

Returns:

The value of the field p

writeP

public void writeP(MemorySegment p)

Write a value in the field p.

Parameters:

p - The new value for the field p

readI

public @org.jspecify.annotations.Nullable int @Nullable [] readI()

Read the value of the field i.

Returns:

The value of the field i

writeI

public void writeI(@org.jspecify.annotations.Nullable int @Nullable [] i,
 Arena _arena)

Write a value in the field i.

Parameters:

i - The new value for the field i

clear

public void clear()

Frees the resources allocated to a lock with g_rw_lock_init().

This function should not be used with a GRWLock that has been statically allocated.

Calling g_rw_lock_clear() when any thread holds the lock leads to undefined behaviour.

Since:

2.32

init

public void init()

Initializes a GRWLock so that it can be used.

This function is useful to initialize a lock that has been allocated on the stack, or as part of a larger structure. It is not necessary to initialise a reader-writer lock that has been statically allocated.

  typedef struct {
     GRWLock l;
     ...
   } Blob;

 Blob *b;

 b = g_new (Blob, 1);
 g_rw_lock_init (&b->l);
 

To undo the effect of g_rw_lock_init() when a lock is no longer needed, use g_rw_lock_clear().

Calling g_rw_lock_init() on an already initialized GRWLock leads to undefined behaviour.

Since:

2.32

readerLock

public void readerLock()

Obtain a read lock on rwLock. If another thread currently holds the write lock on rwLock, the current thread will block until the write lock was (held and) released. If another thread does not hold the write lock, but is waiting for it, it is implementation defined whether the reader or writer will block. Read locks can be taken recursively.

Calling g_rw_lock_reader_lock() while the current thread already owns a write lock leads to undefined behaviour. Read locks however can be taken recursively, in which case you need to make sure to call g_rw_lock_reader_unlock() the same amount of times.

It is implementation-defined how many read locks are allowed to be held on the same lock simultaneously. If the limit is hit, or if a deadlock is detected, a critical warning will be emitted.

Since:

2.32

readerTrylock

public boolean readerTrylock()

Tries to obtain a read lock on this RWLock and returns true if the read lock was successfully obtained. Otherwise it returns false.

Returns:

true if this RWLock could be locked

Since:

2.32

readerUnlock

public void readerUnlock()

Release a read lock on rwLock.

Calling g_rw_lock_reader_unlock() on a lock that is not held by the current thread leads to undefined behaviour.

Since:

2.32

writerLock

public void writerLock()

Obtain a write lock on rwLock. If another thread currently holds a read or write lock on rwLock, the current thread will block until all other threads have dropped their locks on rwLock.

Calling g_rw_lock_writer_lock() while the current thread already owns a read or write lock on this RWLock leads to undefined behaviour.

Since:

2.32

writerTrylock

public boolean writerTrylock()

Tries to obtain a write lock on rwLock. If another thread currently holds a read or write lock on rwLock, it immediately returns false. Otherwise it locks this RWLock and returns true.

Returns:

true if this RWLock could be locked

Since:

2.32

writerUnlock

public void writerUnlock()

Release a write lock on rwLock.

Calling g_rw_lock_writer_unlock() on a lock that is not held by the current thread leads to undefined behaviour.

Since:

2.32