EKM Client API

- Main Page
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions
com::ansys::ingress::client::api::TransferEventAdapter Class Reference

TransferEventAdapter is a convenience class that other classes may extend so that not all methods in the TransferEventListener need to be implemented. No actions are taken on any events in the default implementations of the event methods. More...

Inheritance diagram for com::ansys::ingress::client::api::TransferEventAdapter:

List of all members.

## Public Member Functions

virtual void | TransferStarted (TransferEvent eventObj)
| Handles a transfer started event.
virtual void | TransferCompleted (TransferEvent eventObj)
| Handles a transfer completed event.
virtual void | TransferCached (TransferEvent eventObj)
| Handles a transfer cached event.
virtual void | TransferFailed (TransferEvent eventObj)
| Handles a transfer completed event.
virtual void | TransferProgress (TransferEvent eventObj)
| Handles a transfer progress event.
virtual void | TransferCanceled (TransferEvent eventObj)
| Handles a transfer canceled event.
virtual void | MetadataExtractionStarted (TransferEvent eventObj)
| Indicates metadata extraction was started on the server.
virtual void | MetadataExtractionEnded (TransferEvent eventObj)
| Indicates metadata extraction has ended on the server.
virtual void | FileDownloaded (TransferEvent eventObj)
| Indicates a file was downloaded from the server.

## Detailed Description

TransferEventAdapter is a convenience class that other classes may extend so that not all methods in the TransferEventListener need to be implemented. No actions are taken on any events in the default implementations of the event methods.

## Member Function Documentation

virtual void com::ansys::ingress::client::api::TransferEventAdapter::FileDownloaded | ( | TransferEvent | eventObj | ) | `[inline, virtual]`

Indicates a file was downloaded from the server.

Parameters:

  eventObj | detailed event information

Implements com::ansys::ingress::client::api::TransferEventListener.

virtual void com::ansys::ingress::client::api::TransferEventAdapter::MetadataExtractionEnded | ( | TransferEvent | eventObj | ) | `[inline, virtual]`

Indicates metadata extraction has ended on the server.

Parameters:

  eventObj | detailed event information

Implements com::ansys::ingress::client::api::TransferEventListener.

virtual void com::ansys::ingress::client::api::TransferEventAdapter::MetadataExtractionStarted | ( | TransferEvent | eventObj | ) | `[inline, virtual]`

Indicates metadata extraction was started on the server.

Parameters:

  eventObj | detailed event information

Implements com::ansys::ingress::client::api::TransferEventListener.

virtual void com::ansys::ingress::client::api::TransferEventAdapter::TransferCached | ( | TransferEvent | eventObj | ) | `[inline, virtual]`

Handles a transfer cached event.

Parameters:

  eventObj | detailed event information

Implements com::ansys::ingress::client::api::TransferEventListener.

virtual void com::ansys::ingress::client::api::TransferEventAdapter::TransferCanceled | ( | TransferEvent | eventObj | ) | `[inline, virtual]`

Handles a transfer canceled event.

Parameters:

  eventObj | detailed event information

Implements com::ansys::ingress::client::api::TransferEventListener.

virtual void com::ansys::ingress::client::api::TransferEventAdapter::TransferCompleted | ( | TransferEvent | eventObj | ) | `[inline, virtual]`

Handles a transfer completed event.

Parameters:

  eventObj | detailed event information

Implements com::ansys::ingress::client::api::TransferEventListener.

virtual void com::ansys::ingress::client::api::TransferEventAdapter::TransferFailed | ( | TransferEvent | eventObj | ) | `[inline, virtual]`

Handles a transfer completed event.

Parameters:

  eventObj | detailed event information

Implements com::ansys::ingress::client::api::TransferEventListener.

virtual void com::ansys::ingress::client::api::TransferEventAdapter::TransferProgress | ( | TransferEvent | eventObj | ) | `[inline, virtual]`

Handles a transfer progress event.

Parameters:

  eventObj | detailed event information

Implements com::ansys::ingress::client::api::TransferEventListener.

virtual void com::ansys::ingress::client::api::TransferEventAdapter::TransferStarted | ( | TransferEvent | eventObj | ) | `[inline, virtual]`

Handles a transfer started event.

Parameters:

  eventObj | detailed event information

Implements com::ansys::ingress::client::api::TransferEventListener.

The documentation for this class was generated from the following file:

- TransferMonitor.cs

All Classes Namespaces Functions Variables Enumerations Properties