→ home
 
→ index of namespace default
 
→ index of project core
 
→ index of module core

Class core.Mailbox


Synopsis: A generic event mailbox.

  Methods:
Method allocEventQueue
Discard events and allocate new (empty) queue
Signature
allocEventQueue(intsize)
Arguments
intsize–Queue size

 
→ top of page
Method freeEventQueue
Discard all events
Signature
freeEventQueue()

 
→ top of page
Method getNumQueuedEvents
thread-safe way to get the number of queued events
Signature
getNumQueuedEvents():int
Returns
int–

 
→ top of page
Method peekEvent
Return reference to oldest event without removing it from the queue
Signature
peekEvent():Event
Returns
Event–Event

 
→ top of page
Method peekEvent
Return reference to oldest event that matches the given id
Signature
peekEvent(intid)
 :Event
Arguments
intid–Id to match
Returns
Event–Event

 
→ top of page
Method sendEvent
Create a copy of "ev" (deref value) and add to queue
Signature
sendEvent(Eventev)
Arguments
Eventev–Event to send to this mailbox

 
→ top of page
Method waitEvent
Wait until next event arrives or until timeout expires. return null or next event
Signature
waitEvent(inttimeout)
 :Event
Arguments
inttimeout–Timeout (in millisec). 0=forever
Returns
Event–Event

 
→ top of page
Method waitEvent
Wait until next event arrives that matches the given id or until timeout expires. return null or next event
Signature
waitEvent(intid,
  inttimeout 
  )  
 :Event
Arguments
intid–Id to match
inttimeout–Timeout (in millisec). 0=forever
Returns
Event–Event

 
→ top of page
 

Project Modules:core 
Project Classes:Boolean , Buffer , Byte , Class , ClassArray , Condition , Configuration , Double , DummyStream , Envelope , Event , Exception , File , Float , FloatArray , FloatArray128 , FloatArray16 , FloatArray32 , FloatArray64 , FloatArray8 , Function , HashTable , IntArray , IntArray128 , IntArray16 , IntArray32 , IntArray64 , IntArray8 , Integer , List , ListNode , Long , Mailbox , Mutex , Object , ObjectArray , PakFile , PointerArray , Pool , Script , SharedBuffer , Short , Stack , StdErrStream , StdInStream , StdOutStream , Stream , String , String128 , String16 , String32 , String64 , String8 , StringArray , StringIterator , Thread , Time , TKS , TreeNode , UnsignedByte , UnsignedInteger , UnsignedLong , UnsignedShort , Value , ValueArray , Variable 
Project Functions:ceil , exit , floor , GetCurrentThread , getenv , lcchar , mathAbsMaxf , mathAbsMinf , mathAbsMini , mathAbsMini , mathClampf , mathClampi , mathDistancePointPlane2d , mathLerpf , mathMaxf , mathMaxi , mathMinf , mathMini , mathPowerf , mathPoweri , mathSmoothStepf , mathWrapf , mathWrapi , milliSeconds , psystem , putenv , srand , system , ucchar 
All Namespaces:default , ui 
All Projects:core , debugtext , tkfreetype2 , tkmath , tkmidi , tkopengl , tkportaudio , tksdl , tkui , tkunit 


auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54