SimuTraceX.h File Reference

#include "SimuTrace.h"
#include "SimuTraceXTypes.h"

Macros
#define	SIMUTRACEX_API   SIMUTRACE_API

Functions
SIMUTRACEX_API StreamId	StXStreamFindByName (SessionId session, const char *name, StreamQueryInformation *info)
	Returns the id of the stream with the specified name. More...
SIMUTRACEX_API StreamId	StXMultiplexerCreate (SessionId session, const char *name, MultiplexingRule rule, MultiplexerFlags flags, StreamId *inputStreams, uint32_t count)
	Creates a new stream multiplexer. More...

Function Documentation

SIMUTRACEX_API StreamId StXStreamFindByName	(	SessionId	session,
		const char *	name,
		StreamQueryInformation *	info
	)

This method searches the list of available streams for a stream with the given name and returns its id and detailed properties.

Parameters

session	The id of the session in which to search for the stream.
name	The name of the stream to search for.
info	Optional pointer to a StreamQueryInformation structure to receive detailed stream information.

Returns

The id of the stream with the given name on success, INVALID_STREAM_ID, otherwise. For a more detailed error description call StGetLastError().

Since

3.2

SIMUTRACEX_API StreamId StXMultiplexerCreate	(	SessionId	session,
		const char *	name,
		MultiplexingRule	rule,
		MultiplexerFlags	flags,
		StreamId *	inputStreams,
		uint32_t	count
	)

A stream multiplexer chooses the next entry from a set of input streams based on a defined rule. The multiplexer is accessed like a regular stream.

Parameters

session	The session for which the multiplexer should be created.
name	A friendly name for the multiplexer.
rule	The multiplexing rule, which determines the next entry.
flags	A set of flags to customize multiplexing behavior.
inputStreams	Pointer to an array of streams that should be used as input for the multiplexer.
count	The number of elements in the inputStreams array.

Returns

The id the dynamic stream representing the created multiplexer. Read entries from the multiplexer by reading entries from the stream with the returned id. The id is INVALID_STREAM_ID on error. For a more detailed error description call StGetLastError().

Remarks

The multiplexer will only be visible in the same session for the client that created the multiplexer.

Since

3.2

See also

StStreamOpen()

StGetNextEntry()