Datasnap.Win.SConnect.ITransport.GetWaitEvent
| [–] Properties | |
|---|---|
| Type: function | |
| Visibility: public | |
| Source: Datasnap.Win.SConnect.pas Datasnap.Win.SConnect.hpp
| |
| Unit: Datasnap.Win.SConnect | |
| Parent: ITransport | |
Delphi
function GetWaitEvent: THandle; stdcall;
C++
virtual Winapi::Windows::THandle __stdcall GetWaitEvent() = 0 ;
Description
Returns the handle for an event object that is managed by the object that implements ITransport.
Streamed connection components perform all reading from and writing to the application server using a separate execution thread. This limits the impact that communication with the application server has on the speed of the client application, because execution does not need to wait while messages are marshaled and sent or received. The streamed connection component needs to coordinate its use of the communication thread. To do this, it uses an event object that is a member of the object that implements ITransport.
GetWaitEvent returns a handle to this event object. When implementing an object that supports ITransport, create a TEvent object as a member and return its handle as the return value of GetWaitEvent. Do not use the event object for internal purposes or it will interfere with the streamed connection's use of the event.