ON THIS PAGE
This event is generated by an roAssetFetcher instance when a file transfer succeeds or fails or when population of the asset pool as a whole succeeds or fails.
ifAssetFetcherEvent
GetEvent() As Integer
Returns an integer indicating the result of an roAssetFetcher download attempt:
- 1: POOL_EVENT_FILE_DOWNLOADED
- -1: POOL_EVENT_FILE_FAILED
- 2: POOL_EVENT_ALL_DOWNLOADED
- -2: POOL_EVENT_ALL_FAILED
GetName() As String
GetFailureReason() As String
Returns additional failure information associated with the event (if any).
GetFileIndex() As Integer
Retrieves the zero-based index from the sync spec of the file associated with the event.
GetResponseCode() As Integer
Returns the protocol response code associated with an event. The following codes indicate success:
- 200: Successful HTTP transfer
- 226: Successful FTP transfer
- 0: Successful local file transfer
For unexpected errors, the return value is negative. There are many possible negative errors from the CURL library, but it is often best to look at the text version by calling GetFailureReason().
Here are some potential errors. Not all of them can be generated by a BrightSign player:
Status | Name | Description |
-1 | CURLE_UNSUPPORTED_PROTOCOL |
|
-2 | CURLE_FAILED_INIT |
|
-3 | CURLE_URL_MALFORMAT |
|
-5 | CURLE_COULDNT_RESOLVE_PROXY |
|
-6 | CURLE_COULDNT_RESOLVE_HOST |
|
-7 | CURLE_COULDNT_CONNECT |
|
-8 | CURLE_FTP_WEIRD_SERVER_REPLY |
|
-9 | CURLE_REMOTE_ACCESS_DENIED | A service was denied by the server due to lack of access. When login fails, this is not returned. |
-11 | CURLE_FTP_WEIRD_PASS_REPLY |
|
-13 | CURLE_FTP_WEIRD_PASV_REPLY |
|
-14 | CURLE_FTP_WEIRD_227_FORMAT |
|
-15 | CURLE_FTP_CANT_GET_HOST |
|
-17 | CURLE_FTP_COULDNT_SET_TYPE |
|
-18 | CURLE_PARTIAL_FILE |
|
-19 | CURLE_FTP_COULDNT_RETR_FILE |
|
-21 | CURLE_QUOTE_ERROR | Failed quote command |
-22 | CURLE_HTTP_RETURNED_ERROR |
|
-23 | CURLE_WRITE_ERROR |
|
-25 | CURLE_UPLOAD_FAILED | Failed upload command. |
-26 | CURLE_READ_ERROR | Could not open/read from file. |
-27 | CURLE_OUT_OF_MEMORY |
|
-28 | CURLE_OPERATION_TIMEDOUT | The timeout time was reached. |
-30 | CURLE_FTP_PORT_FAILED | FTP PORT operation failed. |
-31 | CURLE_FTP_COULDNT_USE_REST | REST command failed. |
-33 | CURLE_RANGE_ERROR | RANGE command did not work. |
-34 | CURLE_HTTP_POST_ERROR |
|
-35 | CURLE_SSL_CONNECT_ERROR | Wrong when connecting with SSL. |
-36 | CURLE_BAD_DOWNLOAD_RESUME | Could not resume download. |
-37 | CURLE_FILE_COULDNT_READ_FILE |
|
-38 | CURLE_LDAP_CANNOT_BIND |
|
-39 | CURLE_LDAP_SEARCH_FAILED |
|
-41 | CURLE_FUNCTION_NOT_FOUND |
|
-42 | CURLE_ABORTED_BY_CALLBACK |
|
-43 | CURLE_BAD_FUNCTION_ARGUMENT |
|
-45 | CURLE_INTERFACE_FAILED | CURLOPT_INTERFACE failed. |
-47 | CURLE_TOO_MANY_REDIRECTS | Catch endless re-direct loops. |
-48 | CURLE_UNKNOWN_TELNET_OPTION | User specified an unknown option. |
-49 | CURLE_TELNET_OPTION_SYNTAX | Malformed telnet option. |
-51 | CURLE_PEER_FAILED_VERIFICATION | Peer's certificate or fingerprint wasn't verified correctly. |
-52 | CURLE_GOT_NOTHING | When this is a specific error. |
-53 | CURLE_SSL_ENGINE_NOTFOUND | SSL crypto engine not found. |
-54 | CURLE_SSL_ENGINE_SETFAILED | Cannot set SSL crypto engine as default. |
-55 | CURLE_SEND_ERROR, | Failed sending network data. |
-56 | CURLE_RECV_ERROR | Failure in receiving network data. |
-58 | CURLE_SSL_CERTPROBLEM | Problem with the local certificate. |
-59 | CURLE_SSL_CIPHER | Could not use specified cipher. |
-60 | CURLE_SSL_CACERT | Problem with the CA cert (path?) |
-61 | CURLE_BAD_CONTENT_ENCODING | Unrecognized transfer encoding. |
-62 | CURLE_LDAP_INVALID_URL | Invalid LDAP URL. |
-63 | CURLE_FILESIZE_EXCEEDED, | Maximum file size exceeded. |
-64 | CURLE_USE_SSL_FAILED, | Requested FTP SSL level failed. |
-65 | CURLE_SEND_FAIL_REWIND, | Sending the data requires a rewind that failed. |
-66 | CURLE_SSL_ENGINE_INITFAILED | Failed to initialize ENGINE. |
-67 | CURLE_LOGIN_DENIED | User, password, or similar field was not accepted and login failed . |
-68 | CURLE_TFTP_NOTFOUND | File not found on server. |
-69 | CURLE_TFTP_PERM | Permission problem on server. |
-70 | CURLE_REMOTE_DISK_FULL | Out of disk space on server. |
-71 | CURLE_TFTP_ILLEGAL | Illegal TFTP operation. |
-72 | CURLE_TFTP_UNKNOWNID | Unknown transfer ID. |
-73 | CURLE_REMOTE_FILE_EXISTS | File already exists. |
-74 | CURLE_TFTP_NOSUCHUSER | No such user. |
-75 | CURLE_CONV_FAILED | Conversion failed. |
-76 | CURLE_CONV_REQD | Caller must register conversion callbacks using the following URL_easy_setopt options: CURLOPT_CONV_FROM_NETWORK_FUNCTION CURLOPT_CONV_TO_NETWORK_FUNCTION CURLOPT_CONV_FROM_UTF8_FUNCTION |
-77 | CURLE_SSL_CACERT_BADFILE | Could not load CACERT file, missing or wrong format. |
-78 | CURLE_REMOTE_FILE_NOT_FOUND | Remote file not found. |
-79 | CURLE_SSH | Error from the SSH layer (this is somewhat generic, so the error message will be important when this occurs). |
-80 | CURLE_SSL_SHUTDOWN_FAILED | Failed to shut down the SSL connection. |
The following error codes are generated by the system software and are outside the range of CURL events:
Status | Name | Description |
-1002 | ENOENT | The specified file does not exist or cannot be created. |
-10001 | Cancelled | The operation has been cancelled. |
-10002 | Exception | The operation caused a local exception. Call GetFailureReason() for more details. |
-10003 | ERROR_EXCEPTION | An unexpected exception occurred. |
-10004 | ERROR_DISK_ERROR | A disk error occurred (usually as a result of the disk being full). |
-10005 | ERROR_POOL_UNSATISFIED | The expected files are not present in the pool. |
-10006 | ERROR_DOWNLOADING_ELSEWHERE | The file is being downloaded by another roAssetFetcher instance. |
-10007 | ERROR_HASH_MISMATCH | A downloaded file did not match its checksum or file size. |
ifUserData
SetUserData(user_data As Object)
Sets the user data that will be returned when events are raised.
GetUserData() As Object
Returns the user data that has previously been set via SetUserData(). It will return Invalid if no data has been set.