EKM Client API

- Main Page
- Namespaces
- Classes

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

Public Member Functions
com::ansys::ingress::client::api::TransferEventListener Interface Reference

TransferEventListener defines the interface that classes should implement to receive events related to a transfer. More...

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

List of all members.

## Public Member Functions

void | TransferStarted (TransferEvent eventObj)
| Indicates a transfer was started.
void | TransferCompleted (TransferEvent eventObj)
| Indicates a transfer completed.
void | TransferCached (TransferEvent eventObj)
| Indicates a transfer has finished transferring files to an EKM cache server.
void | TransferFailed (TransferEvent eventObj)
| Indcates a transfer failed.
void | TransferProgress (TransferEvent eventObj)
| Reports progress on an active transfer.
void | TransferCanceled (TransferEvent eventObj)
| Indicates a transfer was canceled.
void | MetadataExtractionStarted (TransferEvent eventObj)
| Indicates metadata extraction was started on the server.
void | MetadataExtractionEnded (TransferEvent eventObj)
| Indicates metadata extraction has ended on the server.
void | FileDownloaded (TransferEvent eventObj)
| Indicates a file was downloaded from the server.

## Detailed Description

TransferEventListener defines the interface that classes should implement to receive events related to a transfer.

## Member Function Documentation

void com::ansys::ingress::client::api::TransferEventListener::FileDownloaded | ( | TransferEvent | eventObj | ) |

Indicates a file was downloaded from the server.

Parameters:

  eventObj | detailed event information

Implemented in com::ansys::ingress::client::api::TransferEventAdapter.

void com::ansys::ingress::client::api::TransferEventListener::MetadataExtractionEnded | ( | TransferEvent | eventObj | ) |

Indicates metadata extraction has ended on the server.

Parameters:

  eventObj | detailed event information

Implemented in com::ansys::ingress::client::api::TransferEventAdapter.

void com::ansys::ingress::client::api::TransferEventListener::MetadataExtractionStarted | ( | TransferEvent | eventObj | ) |

Indicates metadata extraction was started on the server.

Parameters:

  eventObj | detailed event information

Implemented in com::ansys::ingress::client::api::TransferEventAdapter.

void com::ansys::ingress::client::api::TransferEventListener::TransferCached | ( | TransferEvent | eventObj | ) |

Indicates a transfer has finished transferring files to an EKM cache server.

Parameters:

  eventObj | detailed event information

Implemented in com::ansys::ingress::client::api::TransferEventAdapter.

void com::ansys::ingress::client::api::TransferEventListener::TransferCanceled | ( | TransferEvent | eventObj | ) |

Indicates a transfer was canceled.

Parameters:

  eventObj | detailed event information

Implemented in com::ansys::ingress::client::api::TransferEventAdapter.

void com::ansys::ingress::client::api::TransferEventListener::TransferCompleted | ( | TransferEvent | eventObj | ) |

Indicates a transfer completed.

Parameters:

  eventObj | detailed event information

Implemented in com::ansys::ingress::client::api::TransferEventAdapter.

void com::ansys::ingress::client::api::TransferEventListener::TransferFailed | ( | TransferEvent | eventObj | ) |

Indcates a transfer failed.

Parameters:

  eventObj | detailed event information

Implemented in com::ansys::ingress::client::api::TransferEventAdapter.

void com::ansys::ingress::client::api::TransferEventListener::TransferProgress | ( | TransferEvent | eventObj | ) |

Reports progress on an active transfer.

Parameters:

  eventObj | detailed event information

Implemented in com::ansys::ingress::client::api::TransferEventAdapter.

void com::ansys::ingress::client::api::TransferEventListener::TransferStarted | ( | TransferEvent | eventObj | ) |

Indicates a transfer was started.

Parameters:

  eventObj | detailed event information

Implemented in com::ansys::ingress::client::api::TransferEventAdapter.

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

- TransferMonitor.cs

All Classes Namespaces Functions Variables Enumerations Properties