PsyInternal.h File Reference

Built-in internal cranks and message-script playback structures. More...

#include "Utils.h"
#include "PsyAPI.h"
#include "Bitmap.h"

Include dependency graph for PsyInternal.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	cmlabs::TrackPlayerMessageEntry
	One key/value entry of a scripted TrackPlayerMessage. More...
struct	cmlabs::TrackPlayerMessage
	One scripted post/signal action for the message-script player (Internal_MessageScript). More...

Namespaces
namespace	cmlabs

Functions
Built-in internal cranks
CrankFunction implementations registered by PsySpace under reserved names. Each takes the component's PsyAPI handle and returns an int8 status.
int8	cmlabs::Internal_Simple (PsyAPI *api)
	Pass-through test crank: copies each incoming message to its posts.
int8	cmlabs::Internal_Ping (PsyAPI *api)
	Latency test: posts pings, expects pongs.
int8	cmlabs::Internal_Pong (PsyAPI *api)
	Latency test counterpart: answers pings.
int8	cmlabs::Internal_Shutdown (PsyAPI *api)
	Initiates system shutdown when triggered.
int8	cmlabs::Internal_Print (PsyAPI *api)
	Prints incoming messages to the console/log.
int8	cmlabs::Internal_Time (PsyAPI *api)
	Posts time information/timestamps.
int8	cmlabs::Internal_SignalPing (PsyAPI *api)
	Signal-based ping test.
int8	cmlabs::Internal_SignalPong (PsyAPI *api)
	Signal-based pong counterpart.
int8	cmlabs::Internal_RetrieveTest (PsyAPI *api)
	Exercises whiteboard retrieve calls.
int8	cmlabs::Internal_MessageScript (PsyAPI *api)
	Plays back scripted TrackPlayerMessage sequences.
int8	cmlabs::Internal_QueryTest (PsyAPI *api)
	Exercises query/queryReply round-trips.
int8	cmlabs::Internal_StatsLog (PsyAPI *api)
	Periodically logs system statistics.
int8	cmlabs::Internal_BitmapPoster (PsyAPI *api)
	Posts test bitmap/image messages.
int8	cmlabs::Internal_MessageToggler (PsyAPI *api)
	Alternates/toggles message output for testing.
int8	cmlabs::Internal_MessageTypeConverter (PsyAPI *api)
	Converts incoming messages to another type before reposting.

Detailed Description

Built-in internal cranks and message-script playback structures.

Declares the CMSDK's built-in component entry functions (Internal_*), each a CrankFunction registered under a well-known name by PsySpace for system services, diagnostics and testing (ping/pong, shutdown, scripted message playback, stats logging, etc.), plus the TrackPlayerMessage structures used by the message-script player.

Definition in file PsyInternal.h.