SemysGroupTransmitProt
01 Transmit data from any number of members to any number of members.
02

int32 SemysGroupTransmitProt(HSemysGroup group, void const *pData, uint32 dataSize, uint64 sourceMask, uint64 destinationMask, uint64 dataKey, char const *info);

03 Parameters:
  • group: The group.
  • pData: Pointer to a bytestream that should be transmitted.
  • dataSize: How many bytes should be transmitted.
  • sourceMask: The source member mask.
  • destinationMask: The destination member mask.
  • dataKey: Optional predefined data key value.
  • info: Optional short description text.
04 Return Values:
Nonzero if the data will be transmitted, 0 otherwise (Invalid group or no source / destination masks).
05 The provided data will be copied into an internal buffer, so the owner keeps ownership over the data and can free it immediately.
06 The source mask specifies which members will need to transmit the same data as well before it will be delivered to the destination members. (The group sub-system handles missing source members properly)
07 It is optional to specify the data key (!= 0), overriding the internal generation according to the passed data. See About: Sequential Consistency.11 for details.
08 The 'info' parameter is optional and is recommended to be set during debugging. Any transmission request specific trace will contain this string (up to 100 characters).
If bandwidth is an issue, it is advised to set this parameter to 0 in release environments.
09 Although any combination of source and destination masks can be applied, only a small subset is effective. See About: Sequential Consistency.10 for details.
10 Global Lock: Required
Reference: SemysGroup.h
Implementation: Semys Library
See Also: Group Sub-System, SemysGroupReceiveProt()

Goto: Main Page; This page is part of the Semys software documentation. See About: Documentation for details.