mmsync_sync_error_type_t

mm-sync error types

Synopsis:

#include <mmsync/event.h>
typedef enum mmsync_sync_error_type {
      MMSYNC_SYNC_ERROR_NONE = 0,   
      MMSYNC_SYNC_ERROR_MEDIABUSY,   
      MMSYNC_SYNC_ERROR_READ,   
      MMSYNC_SYNC_ERROR_NETWORK,   
      MMSYNC_SYNC_ERROR_UNSUPPORTED,   
      MMSYNC_SYNC_ERROR_USERCANCEL,   
      MMSYNC_SYNC_ERROR_NOTSPECIFIED,   
      MMSYNC_SYNC_ERROR_LIB_LIMIT,   
      MMSYNC_SYNC_ERROR_FOLDER_LIMIT,   
      MMSYNC_SYNC_ERROR_DATABASE,   
      MMSYNC_SYNC_ERROR_FOLDER_DEPTH_LIMIT,   
      MMSYNC_SYNC_ERROR_DB_LIMIT,   
      MMSYNC_SYNC_ERROR_FOLDER_NONMEDIA_LIMIT,   
      MMSYNC_SYNC_ERROR_FOLDER_MEDIA_LIMIT,   
      MMSYNC_SYNC_ERROR_MEMORY_ALLOCATION,
} mmsync_sync_error_type_t;

Data:

MMSYNC_SYNC_ERROR_NONE

No synchronization error.

Delivered when: Never (placeholder).

Event data: None.

DB tables updated: None.

MMSYNC_SYNC_ERROR_MEDIABUSY

The media was busy and the synchronization wasn't allowed to start on the media because of concurrency rules.

Delivered when: The synchronization should have started on a device.

Event data: operation_id: The synchronization operation ID.

DB tables updated: mediastores.

MMSYNC_SYNC_ERROR_READ

A read error prevented the device from being synchronized. This can be caused by a scratched disc, for example.

Delivered when: The synchronization fails because of a read error.

Event data: operation_id: The synchronization operation ID.

DB tables updated: mediastores.

MMSYNC_SYNC_ERROR_NETWORK

A network error occurred during the synchronization. This can be caused by a metadata lookup that couldn't access the network.

Delivered when: The synchronization experiences a network error.

Event data: operation_id: The synchronization operation ID.

DB tables updated: mediastores.

MMSYNC_SYNC_ERROR_UNSUPPORTED

The type of mediastore to synchronize isn't supported by mm-sync.

Delivered when: The synchronization starts but determines the device is unsupported.

Event data: operation_id: The synchronization operation ID.

DB tables updated: mediastores.

MMSYNC_SYNC_ERROR_USERCANCEL

The synchronization was stopped by a client request.

Delivered when: A client requests that synchronization be stopped.

Event data: operation_id: The synchronization operation ID.

DB tables updated: mediastores.

MMSYNC_SYNC_ERROR_NOTSPECIFIED

A nonspecified error occured that isn't classified by other error types.

Delivered when: Any time during synchronization.

Event data: operation_id: The synchronization operation ID.

DB tables updated: None.

MMSYNC_SYNC_ERROR_LIB_LIMIT

The files pass of synchronization reached a configuration limit; no further entries may be added to the files table.

Delivered when: When the maximum number of database entries has been reached during the files pass.

Event data: operation_id: The synchronization operation ID. param: The limit that the mediastore reached.

DB tables updated: None.

MMSYNC_SYNC_ERROR_FOLDER_LIMIT

The files pass of synchronization reached a configuration limit; no further entries may be added to the files table.

Delivered when: When the maximum number of folder items presented to mm-sync has exceeded the configured limit on how many folder items can be scanned for synchronization.

Event data: operation_id: The synchronization operation ID. param: The folder ID that the limit was reached in.

DB tables updated: None.

MMSYNC_SYNC_ERROR_DATABASE

The synchronization encountered a database problem.

Delivered when: A database operation fails during synchronization.

Event data: TBD.

DB tables updated: None.

MMSYNC_SYNC_ERROR_FOLDER_DEPTH_LIMIT

The mm-sync service skipped synchronizing a folder to avoid exceeding the configured maximum folder depth.

Delivered when: The first time mm-sync skips a folder because it has reached the configured maximum folder depth.

Event data: operation_id: The synchronization operation ID. param: The folder ID that the limit was reached in.

DB tables updated: None.

MMSYNC_SYNC_ERROR_DB_LIMIT

The maximum database size has been reached; no further data may be added to the files and playlist tables.

Delivered when: When mm-sync notices that the maximum database size has been reached and stops the synchronization to keep the database size manageable.

Event data: operation_id: The synchronization operation ID.

DB tables updated: None.

MMSYNC_SYNC_ERROR_FOLDER_NONMEDIA_LIMIT

The files pass of synchronization reached the nonmedia file limit, so no entries for this folder will be added to the files table.

Delivered when: When the maximum number of nonmedia items in a folder reaches the configured limit.

Event data: operation_id: The synchronization operation ID. param: The ID of the folder in which the limit was reached.

DB tables updated: None.

MMSYNC_SYNC_ERROR_FOLDER_MEDIA_LIMIT

The files pass of synchronization reached the media file limit, so no further entries for this folder will be added to the files table.

Delivered when: When the maximum number of media items in a folder reaches the configured limit.

Event data: operation_id: The synchronization operation ID. param: The ID of the folder in which the limit was reached.

DB tables updated: None.

MMSYNC_SYNC_ERROR_MEMORY_ALLOCATION

The service had problems allocating memory.

Delivered when: When the service can't allocate sufficient memory during a synchronization.

Event data: The mmsync_sync_error_t structure, which contains:

  • The synchronization operation ID

DB tables updated: None.

Library:

mmsyncclient

Description:

The mm-sync error types.