ServerAgent.WaitHandle property

Microsoft Office Live Communications Server 2005 with SP1

ServerAgent.WaitHandle

The WaitHandle property contains an internal handle used to signal that there is pending input from the Live Communications server that the server agent needs to process.

[C#]public WaitHandle WaitHandle {get;}
[Visual Basic .NET]Public ReadOnly Property WaitHandle As WaitHandle

Remarks

Applications should wait on this handle, and whenever it is signaled, call ServerAgent.ProcessEvent. This mechanism allows applications to control the concurrency model. For example, applications can queue up work items using the ThreadPool class.

Example Code

The following example demonstrates the use of a wait handle when queuing work items in a thread pool.

public void LCServerEventHandler(ServerAgent sa)
{
   ManualResetEvent autoResetEvent = new ManualResetEvent(false);
   WaitHandle[] handleArray = new WaitHandle[] { 
                                 myAppServerAgent.WaitHandle, 
                                 manualResetEvent 
                              };

   WaitCallback waitCallback = new WaitCallback(myAppServerAgent.ProcessEvent);

   while (true) 
   {    
      int signaledEvent = WaitHandle.WaitAny(handleArray);

      if (signaledEvent == 0)  // The server event wait handle (index = 0) in handleArray was signaled
      {

          // Schedule a worker thread to process the server event
          try
          {
             if (!ThreadPool.QueueUserWorkItem(waitCallBack))
             {
                 Console.WriteLine("QueueUserWorkItem fails, quitting.");
                 return;
             }

          } 
          catch (Exception e) 
          {
             Console.WriteLine("Unexpected exception: {0}\n{1}", 
                               e.Message,
                               e.StackTrace);
          }             
       } 
       else // Manual reset event handle (index = 1) in handle array was signaled
       {
          Console.WriteLine("Quit handle signaled, worker will quit now\n");
          break;                
       }
   }
}

Requirements

Redistributable: Requires Microsoft Office Live Communications Server 2005 with SP1.
Namespace: Microsoft.Rtc.Sip
Assembly: ServerAgent (in ServerAgent.dll)

See Also

ServerAgent

What did you think of this topic?
© 2008 Microsoft Corporation. All rights reserved.