interface ti.uiactools.runtime.IUIAPacketTransfer |  |

index URL

- C synopsis
- Individual elements

`XDCspec` summary | sourced in ti/uiactools/runtime/IUIAPacketTransfer.xdc

``interface IUIAPacketTransfer { ...
``// inherits ti.uia.events.IUIAMetaProvider
`` // inherits xdc.runtime.IModule
``instance: ...

`XDCspec` declarations | sourced in ti/uiactools/runtime/IUIAPacketTransfer.xdc

``package ti.uiactools.runtime;
``interface IUIAPacketTransfer inherits IUIAMetaProvider {
module-wide constants & types
`` ``enum TransferType// {
`` `` TransferType_RELIABLE,
`` `` TransferType_LOSSY
`` ``};
module-wide config parameters
`` ``metaonly config Types.Common$ common$// Common module configuration parameters;
````instance:
per-instance config parameters
`` ``config IUIAPacketTransfer.TransferType transferType// = IUIAPacketTransfer.TransferType_LOSSY;
per-instance functions
`` ``Bool disable// Disable packet upload();
`` ``Bool enable// Enable packet upload();
`` ``IUIAPacketTransfer.TransferType getTransferType// ();
`` ``Bool isEmpty// Returns true if the transfer buffer has no unread data();
`` ``UInt32 poll// Check if data is ready and, if so, trigger buffer exchange to send the data as packets. Call readyToSend after this call to check if there is data available to send();
`` ``Bool prime// (Ptr buffer);
`` ``Bool readyToSend// check to see if the ETB drain buffer contains unsent data. If true, call transferData API to send the data();
`` ``Bool transferData// Read and Transfer ETB data move the binary data to PC host via event packets for further decoding and analysis(UInt32 maxNumPackets);
``}

enum IUIAPacketTransfer.TransferType |

index URL

`XDCspec` declarations | sourced in ti/uiactools/runtime/IUIAPacketTransfer.xdc

````enum TransferType {
```` TransferType_RELIABLE,
```` TransferType_LOSSY
````};

metaonly config IUIAPacketTransfer.common$ // module-wide |

index URL

Common module configuration parameters

`XDCspec` declarations | sourced in ti/uiactools/runtime/IUIAPacketTransfer.xdc

````metaonly config Types.Common$ common$;
DETAILS
All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.

config IUIAPacketTransfer.transferType // instance |

index URL

`XDCspec` declarations | sourced in ti/uiactools/runtime/IUIAPacketTransfer.xdc

````config IUIAPacketTransfer.TransferType transferType = IUIAPacketTransfer.TransferType_LOSSY;

IUIAPacketTransfer.disable() // instance |

index URL

Disable packet upload

`XDCspec` declarations | sourced in ti/uiactools/runtime/IUIAPacketTransfer.xdc

````Bool disable();
RETURNS
The function returns the state of the packet upload (`TRUE` if enabled, `FALSE` if disabled) before the call. This return value allows clients to restore the previous state. Note: not thread safe.

IUIAPacketTransfer.enable() // instance |

index URL

Enable packet upload

`XDCspec` declarations | sourced in ti/uiactools/runtime/IUIAPacketTransfer.xdc

````Bool enable();
RETURNS
The function returns the state of the packet upload (`TRUE` if enabled, `FALSE` if disabled) before the call. This return value allows clients to restore the previous state. Note: not thread safe.

IUIAPacketTransfer.getTransferType() // instance |

index URL

`XDCspec` declarations | sourced in ti/uiactools/runtime/IUIAPacketTransfer.xdc

````IUIAPacketTransfer.TransferType getTransferType();

IUIAPacketTransfer.isEmpty() // instance |

index URL

Returns true if the transfer buffer has no unread data

`XDCspec` declarations | sourced in ti/uiactools/runtime/IUIAPacketTransfer.xdc

````Bool isEmpty();
RETURN
true if no unread data

IUIAPacketTransfer.poll() // instance |

index URL

Check if data is ready and, if so, trigger buffer exchange to send the data as packets. Call readyToSend after this call to check if there is data available to send

`XDCspec` declarations | sourced in ti/uiactools/runtime/IUIAPacketTransfer.xdc

````UInt32 poll();
RETURNS
0 if success, else error code

IUIAPacketTransfer.prime() // instance |

index URL

`XDCspec` declarations | sourced in ti/uiactools/runtime/IUIAPacketTransfer.xdc

````Bool prime(Ptr buffer);

IUIAPacketTransfer.readyToSend() // instance |

index URL

check to see if the ETB drain buffer contains unsent data. If true, call transferData API to send the data

`XDCspec` declarations | sourced in ti/uiactools/runtime/IUIAPacketTransfer.xdc

````Bool readyToSend();
RETURNS
TRUE if there is unsent data.

IUIAPacketTransfer.transferData() // instance |

index URL

Read and Transfer ETB data move the binary data to PC host via event packets for further decoding and analysis

`XDCspec` declarations | sourced in ti/uiactools/runtime/IUIAPacketTransfer.xdc

````Bool transferData(UInt32 maxNumPackets);
ARGUMENTS
maxNumPackets — maximum number of packets to send in context of this API call
generated on Wed, 27 Jun 2012 04:11:41 GMT