Event Functions (TipcEvent*)

TipcEvent* functions provide an asynchronous programming model. A dispatcher can manage these types of events:

Connection events — triggered by read or write availability on a connection. Connection events are used to bypass the RTserver when sending or receiving messages between RTclients.

Message events — triggered when a message arrives on an RTserver connection that matches the event's criteria, such as the message's subject or type. Multiple dispatchers can manage message events, with each running in its own thread. This allows for a high degree of concurrency in processing messages.

Socket events — triggered by read or write availability on a socket. Socket events are typically used when integrating another vendor’s software into a SmartSockets main loop. The vendor’s software must be socket-based.

Timer events — triggered when a timer's time interval has elapsed. Timer events repeat but can be destroyed the first time they are invoked to simulate one-shot events.

User events — are executed immediately without requiring a trigger. User events are useful for inter-thread communication. By running dispatchers in multiple threads, user events can be sent between the dispatchers in a thread-safe manner.

T_IPC_EVENT TipcEventCreate(dispatcher, data, event_func, event_arg) 
T_IPC_DISPATCHER dispatcher; 
T_PTR data; 
T_IPC_EVENT_FUNC event_func; 
T_PTR event_arg;

T_IPC_EVENT TipcEventCreateConn(dispatcher, conn, check_mode, 
event_func, event_arg) 
T_IPC_DISPATCHER dispatcher; 
T_IPC_CONN conn; 
T_IO_CHECK_MODE check_mode; 
T_IPC_EVENT_FUNC event_func; 
T_PTR event_arg;

TipcEventCreateMsg — create a message event triggered by a message’s subject

T_IPC_EVENT TipcEventCreateMsg(dispatcher, srv, subject, event_func, 
event_arg) 
T_IPC_DISPATCHER dispatcher; 
T_IPC_SRV srv; 
T_STR subject; 
T_IPC_EVENT_FUNC event_func; 
T_PTR event_arg;

TipcEventCreateMsgType — create a message event triggered by a message’s type

T_IPC_EVENT TipcEventCreateMsgType(dispatcher, srv, mt, event_func, 
event_arg) 
T_IPC_DISPATCHER dispatcher; 
T_IPC_SRV srv; 
T_IPC_MT mt; 
T_IPC_EVENT_FUNC event_func; 
T_PTR event_arg;

T_IPC_EVENT TipcEventCreateSocket(dispatcher, socket, check_mode, 
event_func, event_arg) 
T_IPC_DISPATCHER dispatcher; 
T_INT4 socket; 
T_IO_CHECK_MODE check_mode; 
T_IPC_EVENT_FUNC event_func; 
T_PTR event_arg;

T_IPC_EVENT TipcEventCreateTimer(dispatcher, interval, event_func, 
dispatch_arg) 
T_IPC_DISPATCHER dispatcher; 
T_REAL8 interval; 
T_IPC_EVENT_FUNC event_func; 
T_PTR event_arg;

T_BOOL TipcEventDestroy(event) 
T_IPC_EVENT event;

TipcEventGetCheckMode — get the check mode value for a connection or socket event

T_BOOL TipcEventGetCheckMode(event, check_mode_return) 
T_IPC_EVENT event; 
T_IO_CHECK_MODE *check_mode_return;

T_BOOL TipcEventGetConn(event, conn_return) 
T_IPC_EVENT event; 
T_IPC_CONN *conn_return;

T_BOOL TipcEventGetData(event, data_return) 
T_IPC_EVENT event; 
T_PTR *data_return;

TipcEventGetDispatcher — get the identifier of a dispatcher for an event of any kind

T_BOOL TipcEventGetDispatcher(event, dispatcher_return) 
T_IPC_EVENT event; 
T_IPC_DISPATCHER *dispatcher_return;

T_BOOL TipcEventGetInterval(event, interval_return) 
T_IPC_EVENT event; 
T_REAL8 *interval_return;

T_BOOL TipcEventGetSocket(event, socket_return) 
T_IPC_EVENT event; 
T_INT4 *socket_return;

TipcEventGetType — get an event’s type (connection, message, socket, timer, or user)

T_BOOL TipcEventGetType(event, type_return) 
T_IPC_EVENT event; 
T_IPC_EVENT_TYPE *type_return;

T_BOOL TipcEventSetInterval(event, interval) 
T_IPC_EVENT event; 
T_REAL8 interval;