JCMais/node-libcurl

View on GitHub
lib/enum/CurlCode.ts

Summary

Maintainability
A
0 mins
Test Coverage
/**
 * Copyright (c) Jonathan Cardoso Machado. All Rights Reserved.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

// https://github.com/curl/curl/blob/7e35eb7729/include/curl/multi.h#L61
/**
 * @public
 */
export enum CurlMultiCode {
  CURLM_CALL_MULTI_PERFORM = -1 /* please call curl_multi_perform() or
  curl_multi_socket*() soon */,
  CURLM_OK,
  CURLM_BAD_HANDLE /* the passed-in handle is not a valid CURLM handle */,
  CURLM_BAD_EASY_HANDLE /* an easy handle was not good/valid */,
  CURLM_OUT_OF_MEMORY /* if you ever get this, you're in deep sh*t */,
  CURLM_INTERNAL_ERROR /* this is a libcurl bug */,
  CURLM_BAD_SOCKET /* the passed in socket argument did not match */,
  CURLM_UNKNOWN_OPTION /* curl_multi_setopt() with unsupported option */,
  CURLM_ADDED_ALREADY /* an easy handle already added to a multi handle was
  attempted to get added - again */,
  CURLM_RECURSIVE_API_CALL /* an api function was called from inside a
  callback */,
  CURLM_WAKEUP_FAILURE /* wakeup is unavailable or failed */,
  CURLM_BAD_FUNCTION_ARGUMENT /* function called with a bad parameter */,
  CURLM_LAST,
  /* just to make code nicer when using curl_multi_socket() you can now check
     for CURLM_CALL_MULTI_SOCKET too in the same style it works for
     curl_multi_perform() and CURLM_CALL_MULTI_PERFORM */
  CURLM_CALL_MULTI_SOCKET = CURLM_CALL_MULTI_PERFORM,
}

// https://github.com/curl/curl/blob/e1be825453/include/curl/curl.h#L478
/**
 * @public
 */
export enum CurlCode {
  CURLE_OK = 0,
  CURLE_UNSUPPORTED_PROTOCOL /* 1 */,
  CURLE_FAILED_INIT /* 2 */,
  CURLE_URL_MALFORMAT /* 3 */,
  CURLE_NOT_BUILT_IN /* 4 - [was obsoleted in August 2007 for
                                    7.17.0, reused in April 2011 for 7.21.5] */,
  CURLE_COULDNT_RESOLVE_PROXY /* 5 */,
  CURLE_COULDNT_RESOLVE_HOST /* 6 */,
  CURLE_COULDNT_CONNECT /* 7 */,
  CURLE_WEIRD_SERVER_REPLY /* 8 */,
  CURLE_REMOTE_ACCESS_DENIED /* 9 a service was denied by the server
                                    due to lack of access - when login fails
                                    this is not returned. */,
  CURLE_FTP_ACCEPT_FAILED /* 10 - [was obsoleted in April 2006 for
                                    7.15.4, reused in Dec 2011 for 7.24.0]*/,
  CURLE_FTP_WEIRD_PASS_REPLY /* 11 */,
  CURLE_FTP_ACCEPT_TIMEOUT /* 12 - timeout occurred accepting server
                                    [was obsoleted in August 2007 for 7.17.0,
                                    reused in Dec 2011 for 7.24.0]*/,
  CURLE_FTP_WEIRD_PASV_REPLY /* 13 */,
  CURLE_FTP_WEIRD_227_FORMAT /* 14 */,
  CURLE_FTP_CANT_GET_HOST /* 15 */,
  CURLE_HTTP2 /* 16 - A problem in the http2 framing layer.
                                    [was obsoleted in August 2007 for 7.17.0,
                                    reused in July 2014 for 7.38.0] */,
  CURLE_FTP_COULDNT_SET_TYPE /* 17 */,
  CURLE_PARTIAL_FILE /* 18 */,
  CURLE_FTP_COULDNT_RETR_FILE /* 19 */,
  CURLE_OBSOLETE20 /* 20 - NOT USED */,
  CURLE_QUOTE_ERROR /* 21 - quote command failure */,
  CURLE_HTTP_RETURNED_ERROR /* 22 */,
  CURLE_WRITE_ERROR /* 23 */,
  CURLE_OBSOLETE24 /* 24 - NOT USED */,
  CURLE_UPLOAD_FAILED /* 25 - failed upload "command" */,
  CURLE_READ_ERROR /* 26 - couldn't open/read from file */,
  CURLE_OUT_OF_MEMORY /* 27 */,
  /* Note: CURLE_OUT_OF_MEMORY may sometimes indicate a conversion error
           instead of a memory allocation error if CURL_DOES_CONVERSIONS
           is defined
  */
  CURLE_OPERATION_TIMEDOUT /* 28 - the timeout time was reached */,
  CURLE_OBSOLETE29 /* 29 - NOT USED */,
  CURLE_FTP_PORT_FAILED /* 30 - FTP PORT operation failed */,
  CURLE_FTP_COULDNT_USE_REST /* 31 - the REST command failed */,
  CURLE_OBSOLETE32 /* 32 - NOT USED */,
  CURLE_RANGE_ERROR /* 33 - RANGE "command" didn't work */,
  CURLE_HTTP_POST_ERROR /* 34 */,
  CURLE_SSL_CONNECT_ERROR /* 35 - wrong when connecting with SSL */,
  CURLE_BAD_DOWNLOAD_RESUME /* 36 - couldn't resume download */,
  CURLE_FILE_COULDNT_READ_FILE /* 37 */,
  CURLE_LDAP_CANNOT_BIND /* 38 */,
  CURLE_LDAP_SEARCH_FAILED /* 39 */,
  CURLE_OBSOLETE40 /* 40 - NOT USED */,
  CURLE_FUNCTION_NOT_FOUND /* 41 - NOT USED starting with 7.53.0 */,
  CURLE_ABORTED_BY_CALLBACK /* 42 */,
  CURLE_BAD_FUNCTION_ARGUMENT /* 43 */,
  CURLE_OBSOLETE44 /* 44 - NOT USED */,
  CURLE_INTERFACE_FAILED /* 45 - CURLOPT_INTERFACE failed */,
  CURLE_OBSOLETE46 /* 46 - NOT USED */,
  CURLE_TOO_MANY_REDIRECTS /* 47 - catch endless re-direct loops */,
  CURLE_UNKNOWN_OPTION /* 48 - User specified an unknown option */,
  CURLE_SETOPT_OPTION_SYNTAX /* 49 - Malformed telnet option */,
  CURLE_OBSOLETE50 /* 50 - NOT USED */,
  CURLE_OBSOLETE51 /* 51 - NOT USED */,
  CURLE_GOT_NOTHING /* 52 - when this is a specific error */,
  CURLE_SSL_ENGINE_NOTFOUND /* 53 - SSL crypto engine not found */,
  CURLE_SSL_ENGINE_SETFAILED /* 54 - can not set SSL crypto engine as
                                    default */,
  CURLE_SEND_ERROR /* 55 - failed sending network data */,
  CURLE_RECV_ERROR /* 56 - failure in receiving network data */,
  CURLE_OBSOLETE57 /* 57 - NOT IN USE */,
  CURLE_SSL_CERTPROBLEM /* 58 - problem with the local certificate */,
  CURLE_SSL_CIPHER /* 59 - couldn't use specified cipher */,
  CURLE_PEER_FAILED_VERIFICATION /* 60 - peer's certificate or fingerprint
                                     wasn't verified fine */,
  CURLE_BAD_CONTENT_ENCODING /* 61 - Unrecognized/bad encoding */,
  CURLE_LDAP_INVALID_URL /* 62 - Invalid LDAP URL */,
  CURLE_FILESIZE_EXCEEDED /* 63 - Maximum file size exceeded */,
  CURLE_USE_SSL_FAILED /* 64 - Requested FTP SSL level failed */,
  CURLE_SEND_FAIL_REWIND /* 65 - Sending the data requires a rewind
                                    that failed */,
  CURLE_SSL_ENGINE_INITFAILED /* 66 - failed to initialise ENGINE */,
  CURLE_LOGIN_DENIED /* 67 - user, password or similar was not
                                    accepted and we failed to login */,
  CURLE_TFTP_NOTFOUND /* 68 - file not found on server */,
  CURLE_TFTP_PERM /* 69 - permission problem on server */,
  CURLE_REMOTE_DISK_FULL /* 70 - out of disk space on server */,
  CURLE_TFTP_ILLEGAL /* 71 - Illegal TFTP operation */,
  CURLE_TFTP_UNKNOWNID /* 72 - Unknown transfer ID */,
  CURLE_REMOTE_FILE_EXISTS /* 73 - File already exists */,
  CURLE_TFTP_NOSUCHUSER /* 74 - No such user */,
  CURLE_CONV_FAILED /* 75 - conversion failed */,
  CURLE_CONV_REQD /* 76 - caller must register conversion
                                    callbacks using curl_easy_setopt options
                                    CURLOPT_CONV_FROM_NETWORK_FUNCTION,
                                    CURLOPT_CONV_TO_NETWORK_FUNCTION, and
                                    CURLOPT_CONV_FROM_UTF8_FUNCTION */,
  CURLE_SSL_CACERT_BADFILE /* 77 - could not load CACERT file, missing
                                    or wrong format */,
  CURLE_REMOTE_FILE_NOT_FOUND /* 78 - remote file not found */,
  CURLE_SSH /* 79 - error from the SSH layer, somewhat
                                    generic so the error message will be of
                                    interest when this has happened */,

  CURLE_SSL_SHUTDOWN_FAILED /* 80 - Failed to shut down the SSL
                                    connection */,
  CURLE_AGAIN /* 81 - socket is not ready for send/recv,
                                    wait till it's ready and try again (Added
                                    in 7.18.2) */,
  CURLE_SSL_CRL_BADFILE /* 82 - could not load CRL file, missing or
                                    wrong format (Added in 7.19.0) */,
  CURLE_SSL_ISSUER_ERROR /* 83 - Issuer check failed.  (Added in
                                    7.19.0) */,
  CURLE_FTP_PRET_FAILED /* 84 - a PRET command failed */,
  CURLE_RTSP_CSEQ_ERROR /* 85 - mismatch of RTSP CSeq numbers */,
  CURLE_RTSP_SESSION_ERROR /* 86 - mismatch of RTSP Session Ids */,
  CURLE_FTP_BAD_FILE_LIST /* 87 - unable to parse FTP file list */,
  CURLE_CHUNK_FAILED /* 88 - chunk callback reported error */,
  CURLE_NO_CONNECTION_AVAILABLE /* 89 - No connection available, the
                                    session will be queued */,
  CURLE_SSL_PINNEDPUBKEYNOTMATCH /* 90 - specified pinned public key did not
                                     match */,
  CURLE_SSL_INVALIDCERTSTATUS /* 91 - invalid certificate status */,
  CURLE_HTTP2_STREAM /* 92 - stream error in HTTP/2 framing layer */,
  CURLE_RECURSIVE_API_CALL /* 93 - an api function was called from inside a callback */,
  CURLE_AUTH_ERROR /* 94 - an authentication function returned an error */,
  CURLE_HTTP3 /* 95 - An HTTP/3 layer problem */,
  CURLE_QUIC_CONNECT_ERROR /* 96 - QUIC connection error */,
  CURLE_PROXY /* 97 - proxy handshake error */,
  CURLE_SSL_CLIENTCERT /* 98 - client-side certificate required */,
  CURLE_LAST,
  /*  compatibility with older names */
  CURLE_FTP_WEIRD_SERVER_REPLY = CURLE_WEIRD_SERVER_REPLY,
  CURLE_SSL_CACERT = CURLE_PEER_FAILED_VERIFICATION,
  CURLE_UNKNOWN_TELNET_OPTION = CURLE_UNKNOWN_OPTION,
  CURLE_SSL_PEER_CERTIFICATE = CURLE_PEER_FAILED_VERIFICATION,
  CURLE_TELNET_OPTION_SYNTAX = CURLE_SETOPT_OPTION_SYNTAX,

  CURLE_FTP_ACCESS_DENIED = CURLE_REMOTE_ACCESS_DENIED,
  CURLE_FTP_COULDNT_SET_BINARY = CURLE_FTP_COULDNT_SET_TYPE,
  CURLE_FTP_QUOTE_ERROR = CURLE_QUOTE_ERROR,
  CURLE_TFTP_DISKFULL = CURLE_REMOTE_DISK_FULL,
  CURLE_TFTP_EXISTS = CURLE_REMOTE_FILE_EXISTS,
  CURLE_HTTP_RANGE_ERROR = CURLE_RANGE_ERROR,
  CURLE_FTP_SSL_FAILED = CURLE_USE_SSL_FAILED,

  /* The following were added earlier */
  CURLE_OPERATION_TIMEOUTED = CURLE_OPERATION_TIMEDOUT,

  CURLE_HTTP_NOT_FOUND = CURLE_HTTP_RETURNED_ERROR,
  CURLE_HTTP_PORT_FAILED = CURLE_INTERFACE_FAILED,
  CURLE_FTP_COULDNT_STOR_FILE = CURLE_UPLOAD_FAILED,

  CURLE_FTP_PARTIAL_FILE = CURLE_PARTIAL_FILE,
  CURLE_FTP_BAD_DOWNLOAD_RESUME = CURLE_BAD_DOWNLOAD_RESUME,
}

// https://github.com/curl/curl/blob/e1be825453/include/curl/curl.h#L2675
/**
 * @public
 */
export enum CurlShareCode {
  CURLSHE_OK /* all is fine */,
  CURLSHE_BAD_OPTION /* 1 */,
  CURLSHE_IN_USE /* 2 */,
  CURLSHE_INVALID /* 3 */,
  CURLSHE_NOMEM /* 4 out of memory */,
  CURLSHE_NOT_BUILT_IN /* 5 feature not present in lib */,
  CURLSHE_LAST,
}