Definition:

#include <aStem.h>
object code: aStem shared library



aLIBRETURN aStem_SetStream(

aStemLib stemRef, aStreamRef streamRef, aStemStreamType streamType, aErr* pErr);

Parameters:

stemRef	-	A pointer to the opaque library reference to set the stream on.
streamRef	-	The new stream to use for communication with the BrainStem.
streamType	-	The type of stream being set.
pErr	-	A pointer to an aErr variable that recieves the error code on exit from this routine.

Return Value:

This library routine returns an aLIBRETURN type that is non-zero if there are errors, and zero if the routine completes with no errors.

Description:

This routine sets the current BrainStem communication stream to the aStreamRef stream reference passed in.  If a previous call had set another aStreamRef , it is closed and destroyed before the new stream is set.  Setting a NULL aStreamRef closes and destroys any previous stream and subsequent calls to aStem_GetPacket or aStem_SendPacket will result in an aErrIO error.

The stream type can be either kStemModuleStream or kStemRelayStream .  If you are connecting to a module, use the kStemModuleStream type.  If you are creating a relay between two different stream types (serial to TCP/IP socket, for instance), you would use the kStemRelayStream .

Related:

aStream_Create, aStream_CreateSerial