This documentation is archived and is not being maintained.

ReaderWriterLock.AcquireWriterLock Method

Acquires the writer lock.

Overload List

Acquires the writer lock, using an Int32 value for the time-out.

[Visual Basic] Overloads Public Sub AcquireWriterLock(Integer)
[C#] public void AcquireWriterLock(int);
[C++] public: void AcquireWriterLock(int);
[JScript] public function AcquireWriterLock(int);

Acquires the writer lock, using a TimeSpan value for the time-out.

[Visual Basic] Overloads Public Sub AcquireWriterLock(TimeSpan)
[C#] public void AcquireWriterLock(TimeSpan);
[C++] public: void AcquireWriterLock(TimeSpan);
[JScript] public function AcquireWriterLock(TimeSpan);

Example

[Visual Basic, C#, C++] Note   This example shows how to use one of the overloaded versions of AcquireWriterLock. For other examples that might be available, see the individual overload topics.
[Visual Basic] 

' The complete code is located in the ReaderWriterLock
' class topic.
Imports System
Imports System.Threading
Imports Microsoft.VisualBasic

Public Class Test
    ' Declaring the ReaderWriterLock at the class level
    ' makes it visible to all threads.
    Private Shared rwl As New ReaderWriterLock()
    ' For this example, the shared resource protected by the
    ' ReaderWriterLock is just an integer.
    Private Shared resource As Integer = 0
    . . . 
    ' Shows how to request and release the writer lock, and
    ' how to handle time-outs.
    Shared Sub WriteToResource(timeOut As Integer)
        Try
            rwl.AcquireWriterLock(timeOut)
            Try
                ' It is safe for this thread to read or write
                ' from the shared resource.
                resource = rnd.Next(500)
                Display("writes resource value " & resource)
                Interlocked.Increment(writes)
            Finally
                ' Ensure that the lock is released.
                rwl.ReleaseWriterLock()
            End Try
        Catch ex As ApplicationException
            ' The writer lock request timed out.
            Interlocked.Increment(writerTimeouts)
        End Try
    End Sub 'WriteToResource
    . . . 
End Class 'Test 

[C#] 
// The complete code is located in the ReaderWriterLock
// class topic.
using System;
using System.Threading;

public class Test
{
    // Declaring the ReaderWriterLock at the class level
    // makes it visible to all threads.
    static ReaderWriterLock rwl = new ReaderWriterLock();
    // For this example, the shared resource protected by the
    // ReaderWriterLock is just an integer.
    static int resource = 0;
    . . . 
    // Shows how to request and release the writer lock, and
    // how to handle time-outs.
    static void WriteToResource(int timeOut)
    {
        try
        {
            rwl.AcquireWriterLock(timeOut);
            try
            {
                // It is safe for this thread to read or write
                // from the shared resource.
                resource = rnd.Next(500);
                Display("writes resource value " + resource);
                Interlocked.Increment(ref writes);
            }        
            finally
            {
                // Ensure that the lock is released.
                rwl.ReleaseWriterLock();
            }
        }
        catch (ApplicationException)
        {
            // The writer lock request timed out.
            Interlocked.Increment(ref writerTimeouts);
        }
    }
    . . . 
}

[C++] 
// The complete code is located in the ReaderWriterLock
// class topic.
#using <mscorlib.dll>

using namespace System;
using namespace System::Threading;

public __gc class Test 
{
public:
    // Declaring the ReaderWriterLock at the class level
    // makes it visible to all threads.
    static ReaderWriterLock* rwl = new ReaderWriterLock();
    // For this example, the shared resource protected by the
    // ReaderWriterLock is just an integer.
    static int resource = 0;
    . . . 
    // Shows how to request and release the writer lock, and
    // how to handle time-outs.
    static void WriteToResource(int timeOut) 
    {
        try 
        {
            rwl->AcquireWriterLock(timeOut);
            try
            {
                // It is safe for this thread to read or write
                // from the shared resource.
                resource = rnd->Next(500);
                Display(String::Format(S"writes resource value {0}", __box(resource)));
                Interlocked::Increment(&writes);

            }        
            __finally 
            {
                // Ensure that the lock is released.
                rwl->ReleaseWriterLock();
            }
        } 
        catch (ApplicationException*) 
        {
            // The writer lock request timed out.
            Interlocked::Increment(&writerTimeouts);
        }
    }
    . . . 
};

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

See Also

ReaderWriterLock Class | ReaderWriterLock Members | System.Threading Namespace

Show: