The
following table briefly describes each OSAL method. For ease of use,
the methods are listed in alphabetical order.
- OSAL Method
- Description
- ~OMOSConnectionPort
- Destroys the OMOSConnectionPort object.
- ~OMOSEventFlag
- Destroys the OMOSEventFlag object.
- ~OMOSMessageQueue
- Destroys the OMOSMessageQueue object.
- ~OMOSMutex
- Destroys the OMOSMutex object.
- ~OMOSSemaphore
- Destroys the OMOSSemaphore object.
- ~OMOSSocket
- Destroys the OMOSSocket object.
- ~OMOSThread
- Destroys the OMOSThread object.
- ~OMOSTimer
- Destroys the OMOSTimer object.
- ~OMTMMessageQueue
- Destroys the OMTMMessageQueue object.
- cleanup
- Cleans up the memory after an object is deleted.
- Close
- Closes the socket.
- Connect
- Connects a process to the instrumentation server
at a given socket address and port.
- create
- Creates a new object.
- Create
- Creates a new socket.
- createOMOSConnectionPort
- Creates a connection port.
- createOMOSEventFlag
- Creates an event flag.
- createOMOSIdleTimer
- Creates an idle timer.
- createOMOSMessageQueue
- Creates a message queue.
- createOMOSMutex
- Creates a mutex.
- createOMOSSemaphore
- Creates a semaphore.
- createOMOSThread
- Creates a thread.
- createOMOSTickTimer
- Creates a tick timer.
- createOMOSWrapperThread
- Creates a wrapper thread.
- createSocket
- Creates a new socket.
- delayCurrentThread
- Delays the current thread for the specified length
of time.
- destroy
- Destroys the object.
- endApplication
- Ends a running application.
- endMyTask
- Terminates the current task.
- endOtherTask
- Terminates a task other than the current task.
- endProlog
- Ends the prolog.
- exeOnMyTask
- Determines whether the method was invoked from
the same operating system task as the one on which the object is running.
- exeOnMyThread
- Determines whether the method was invoked from
the same operating system thread as the one on which the object is
running.
- free
- Releases the lock, possibly causing the underlying
operating system to reschedule threads.
- get
- Retrieves the message at the beginning of the queue.
- getCurrentTaskHandle
- Returns the native operating system handle to the
task.
- getCurrentThreadHandle
- Returns the native operating system handle to the
thread.
- getMessageList
- Retrieves the list of messages.
- getOSHandle
- Retrieves the task's operating system ID.
- getOsHandle
- Retrieves the thread's operating system ID.
- getOsQueue
- Retrieves the event queue.
- getTaskEndClbk
- Is a callback function that ends the current operating
system task.
- getThreadEndClbk
- Is a callback function that ends the current operating
system thread.
- init
- Initializes the new object.
- initEpilog
- Executes operating system-specific actions to be
taken at the end of OXF::init after the environment
has been set (that is, the main thread and the timer have been started)
and before it returns.
- instance
- Creates a single instance of OMOSFactory.
- isEmpty
- Determines whether the message queue is empty.
- isFull
- Determines whether the queue is full.
- lock
- Determines whether the mutex is free and reacts
accordingly.
- OMEventQueue
- Constructs an OMEventQueue object.
- OMTMMessageQueue
- Constructs an OMTMMessageQueue object.
- pend
- Blocks the thread making the call until there is
a message in the queue.
- put
- Adds a message to the end of the message queue.
- receive
- Waits on the socket to receive the data.
- Receive
- Receives data through the socket.
- reset
- Forces the event flag into a known state.
- resume
- Resumes a suspended thread.
- RiCOSEndApplication
- Ends a running application.
- RiCOSOXFInitEpilog
- Initializes the epilog.
- send
- Sends data from the socket.
- Send
- Sends data out from the connection port.
or
Sends data out from the socket.
- SetDispatcher
- Sets the dispatcher function, which is called whenever
there is an input on the connection port (input from the socket).
- setEndOSTaskInCleanup
- Determines whether destruction of the RiCOSTask class
should kill the operating system task associated with the class.
- setEndOSThreadInDtor
- Determines whether destruction of the OMOSThread class
should kill the operating system thread associated with the class.
- setOwnerProcess
- Sets the thread that owns the message queue.
- setPriority
- Sets the operating system priority of the task
or thread.
- signal
- Releases a blocked thread.
- start
- Starts the task or thread processing.
- suspend
- Suspends the task or thread.
- unlock
- Releases the lock, possibly causing the underlying
operating system to reschedule threads.
- wait
- Blocks the thread making the call until some other
thread releases it by calling signal on the same event flag instance.
- waitOnThread
- Waits for a thread to terminate.
See The OSAL classes for detailed
information.