Overview

Module katipo

• Data Types
• Function Index
• Function Details

Behaviours: gen_server.

Data Types

body()

body() = binary()

connecttimeout_ms()

connecttimeout_ms() = pos_integer()

See https://curl.haxx.se/libcurl/c/CURLOPT_CONNECTTIMEOUT.html

cookiejar()

abstract datatype: cookiejar()

curlmopts()

curlmopts() = [{max_pipeline_length, non_neg_integer()} | {pipelining, pipelining()} | {max_total_connections, non_neg_integer()}]

curlopt_http_version()

curlopt_http_version() = curl_http_version_none | curl_http_version_1_0 | curl_http_version_1_1 | curl_http_version_2_0 | curl_http_version_2tls | curl_http_version_2_prior_knowledge

HTTP protocol version to use see https://curl.se/libcurl/c/CURLOPT_HTTP_VERSION.html

doh_url()

doh_url() = binary()

See https://curl.haxx.se/libcurl/c/CURLOPT_DOH_URL.html

error_code()

error_code() = ok | unsupported_protocol | failed_init | url_malformat | not_built_in | couldnt_resolve_proxy | couldnt_resolve_host | couldnt_connect | ftp_weird_server_reply | remote_access_denied | ftp_accept_failed | ftp_weird_pass_reply | ftp_accept_timeout | ftp_weird_pasv_reply | ftp_weird_227_format | ftp_cant_get_host | http2 | ftp_couldnt_set_type | partial_file | ftp_couldnt_retr_file | obsolete20 | quote_error | http_returned_error | write_error | obsolete24 | upload_failed | read_error | out_of_memory | operation_timedout | obsolete29 | ftp_port_failed | ftp_couldnt_use_rest | obsolete32 | range_error | http_post_error | ssl_connect_error | bad_download_resume | file_couldnt_read_file | ldap_cannot_bind | ldap_search_failed | obsolete40 | function_not_found | aborted_by_callback | bad_function_argument | obsolete44 | interface_failed | obsolete46 | too_many_redirects | unknown_option | telnet_option_syntax | obsolete50 | got_nothing | ssl_engine_notfound | ssl_engine_setfailed | send_error | recv_error | obsolete57 | ssl_certproblem | ssl_cipher | '?SSL_CACERT_ERROR_CODE' | bad_content_encoding | ldap_invalid_url | filesize_exceeded | use_ssl_failed | send_fail_rewind | ssl_engine_initfailed | login_denied | tftp_notfound | tftp_perm | remote_disk_full | tftp_illegal | tftp_unknownid | remote_file_exists | tftp_nosuchuser | conv_failed | conv_reqd | ssl_cacert_badfile | remote_file_not_found | ssh | ssl_shutdown_failed | again | ssl_crl_badfile | ssl_issuer_error | ftp_pret_failed | rtsp_cseq_error | rtsp_session_error | ftp_bad_file_list | chunk_failed | no_connection_available | obsolete16 | ssl_pinnedpubkeynotmatch | ssl_invalidcertstatus | curl_last | bad_opts

error_msg()

error_msg() = binary()

header()

header() = {binary(), iodata()}

headers()

headers() = [header()]

http_auth()

http_auth() = basic | digest | ntlm | negotiate

interface()

interface() = binary()

See https://curl.haxx.se/libcurl/c/CURLOPT_INTERFACE.html

method()

method() = get | post | put | head | options | patch | delete

metrics()

metrics() = proplists:proplist()

opts()

opts() = #{headers => headers(), cookiejar => cookiejar(), body => req_body(), connecttimeout_ms => connecttimeout_ms(), followlocation => boolean(), ssl_verifyhost => ssl_verifyhost(), ssl_verifypeer => ssl_verifypeer(), capath => binary(), cacert => binary(), timeout_ms => pos_integer(), maxredirs => non_neg_integer(), http_auth => http_auth(), username => binary(), password => binary(), proxy => proxy(), return_metrics => boolean(), tcp_fastopen => tcp_fastopen(), interface => interface(), unix_socket_path => unix_socket_path(), lock_data_ssl_session => boolean(), doh_url => doh_url(), http_version => curlopt_http_version(), verbose => boolean(), sslcert => sslcert(), sslkey => sslkey(), sslkey_blob => sslkey_blob(), userpwd => userpwd()}

pipelining()

pipelining() = nothing | http1 | multiplex

proxy()

proxy() = binary()

See https://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html

qs_vals()

qs_vals() = [{unicode:chardata(), unicode:chardata() | true}]

req_body()

req_body() = iodata() | qs_vals()

request()

request() = #{url := binary(), method := method(), headers => headers(), cookiejar => cookiejar(), body => req_body(), connecttimeout_ms => connecttimeout_ms(), followlocation => boolean(), ssl_verifyhost => ssl_verifyhost(), ssl_verifypeer => ssl_verifypeer(), capath => binary(), cacert => binary(), timeout_ms => pos_integer(), maxredirs => non_neg_integer(), http_auth => http_auth(), username => binary(), password => binary(), proxy => proxy(), return_metrics => boolean(), tcp_fastopen => tcp_fastopen(), interface => interface(), unix_socket_path => unix_socket_path(), lock_data_ssl_session => boolean(), doh_url => doh_url(), http_version => curlopt_http_version(), verbose => boolean(), sslcert => sslcert(), sslkey => sslkey(), sslkey_blob => sslkey_blob(), userpwd => userpwd()}

response()

response() = {ok, #{status := status(), headers := headers(), cookiejar := cookiejar(), body := body(), metrics => proplists:proplist()}} | {error, #{code := error_code(), message := error_msg()}}

ssl_verifyhost()

ssl_verifyhost() = boolean()

See https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html

ssl_verifypeer()

ssl_verifypeer() = boolean()

See https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html

sslcert()

sslcert() = binary()

See https://curl.haxx.se/libcurl/c/CURLOPT_SSLCERT.html

sslkey()

sslkey() = binary()

See https://curl.haxx.se/libcurl/c/CURLOPT_SSLKEY.html

sslkey_blob()

sslkey_blob() = binary()

See https://curl.haxx.se/libcurl/c/CURLOPT_SSLKEY_BLOB.html

status()

status() = pos_integer()

tcp_fastopen()

tcp_fastopen() = boolean()

See https://curl.haxx.se/libcurl/c/CURLOPT_TCP_FASTOPEN.html

unix_socket_path()

unix_socket_path() = binary()

See https://curl.haxx.se/libcurl/c/CURLOPT_UNIX_SOCKET_PATH.html

url()

url() = binary()

userpwd()

userpwd() = binary()

See https://curl.haxx.se/libcurl/c/CURLOPT_USERPWD.html

Function Index

Function Details

delete/2

Equivalent to delete(Poolname, Url, #{}).

delete/3

get/2

Equivalent to get(Poolname, Url, #{}).

get/3

head/2

Equivalent to head(Poolname, Url, #{}).

head/3

options/2

Equivalent to options(Poolname, Url, #{}).

options/3

patch/2

Equivalent to patch(Poolname, Url, #{}).

patch/3

post/2

Equivalent to post(Poolname, Url, #{}).

post/3

put/2

Equivalent to put(Poolname, Url, #{}).

put/3

Overview

Generated by EDoc