libhv/docs/apis.md

libhv API Manual

base

hplatform.h

• OS: OS_WIN, OS_UNIX (OS_LINUX, OS_ANDROID, OS_DARWIN ...)
• ARCH: ARCH_X86, ARCH_X64, ARCH_ARM, ARCH_ARM64
• BYTE_ORDER: BIG_ENDIAN, LITTLE_ENDIAN
• HV_EXPORT
• stdbool.h: bool, true, false
• stdint.h: int8_t, int16_t, int32_t, int64_t
• var
• hv_delay
• hv_mkdir
• stricmp, strcasecmp

hdef.h

• ABS, NABS
• ARRAY_SIZE
• BEGIN_EXTERN_C, END_EXTERN_C
• BEGIN_NAMESPACE, END_NAMESPACE
• BITSET, BITCLR, BITGET
• CR, LF, CRLF
• DEFAULT
• ENUM, STRUCT
• FLOAT_EQUAL_ZERO
• IN, OUT, INOUT
• INFINITE
• IS_ALPHA, IS_NUM, IS_ALPHANUM
• IS_CNTRL, IS_GRAPH
• IS_HEX
• IS_LOWER, IS_UPPER
• LOWER, UPPER
• LD, LU, LLD, LLU
• MAKEWORD, LOBYTE, HIBYTE
• MAKELONG, LOWORD, HIWORD
• MAKEINT64, LOINT, HIINT
• MAKE_FOURCC
• MAX, MIN, LIMIT
• MAX_PATH
• NULL, TRUE, FALSE
• OPTIONAL, REQUIRED, REPEATED
• SAFE_FREE, SAFE_DELETE, SAFE_DELETE_ARRAY, SAFE_RELEASE
• STRINGCAT
• STRINGIFY
• offsetof, offsetofend
• container_of
• prefetch
• printd

herr.h

• hv_strerror

htime.h

• IS_LEAP_YEAR
• datetime_t
• sleep, msleep, usleep
• gettick
• gettimeofday
• gettimeofday_ms
• gethrtime_us
• datetime_now
• datetime_mktime
• datetime_past
• datetime_future
• duration_fmt
• datetime_fmt
• gmtime_fmt
• days_of_month
• month_atoi
• month_itoa
• weekday_atoi
• weekday_itoa
• hv_compile_datetime
• cron_next_timeout

hmath.h

• floor2e
• ceil2e

hbase.h

• safe_malloc
• safe_calloc
• safe_realloc
• safe_zalloc
• safe_strncpy
• safe_strncat
• strlower
• strupper
• strreverse
• strstartswith
• strendswith
• strcontains
• strlcpy
• strlcat
• strrchr_dot
• strrchr_dir
• hv_basename
• hv_suffixname
• hv_mkdir_p
• hv_rmdir_p
• getboolean
• get_executable_path
• get_executable_dir
• get_executable_file
• get_run_dir

hversion.h

• hv_version
• hv_compile_version
• version_atoi
• version_itoa

hsysinfo.h

• get_ncpu
• get_meminfo

hproc.h

• hproc_spawn

hthread.h

• hv_getpid
• hv_gettid
• HTHREAD_RETTYPE
• HTHREAD_ROUTINE
• hthread_create
• hthread_join
• class HThread

hmutex.h

• hmutex_t
• hmutex_init
• hmutex_destroy
• hmutex_lock
• hmutex_unlock
• hspinlock_t
• hspinlock_init
• hspinlock_destroy
• hspinlock_lock
• hspinlock_unlock
• hrwlock_t
• hrwlock_init
• hrwlock_destroy
• hrwlock_rdlock
• hrwlock_rdunlock
• hrwlock_wrlock
• hrwlock_wrunlock
• htimed_mutex_t
• htimed_mutex_init
• htimed_mutex_destroy
• htimed_mutex_lock
• htimed_mutex_lock_for
• htimed_mutex_unlock
• hcondvar_t
• hcondvar_init
• hcondvar_destroy
• hcondvar_wait
• hcondvar_wait_for
• hcondvar_signal
• hcondvar_broadcast
• hsem_init
• hsem_destroy
• hsem_wait
• hsem_post
• hsem_timedwait
• honce_t
• HONCE_INIT
• honce
• hv::MutexLock
• hv::SpinLock
• hv::RWLock

hsocket.h

• INVALID_SOCKET
• closesocket
• blocking
• nonblocking
• Bind
• Listen
• Connect
• ConnectNonblock
• ConnectTimeout
• Resolver
• Socketpair
• socket_errno
• socket_strerror
• sockaddr_u
• sockaddr_ip
• sockaddr_port
• sockaddr_set_ip
• sockaddr_set_port
• sockaddr_set_ipport
• sockaddr_len
• sockaddr_str
• sockaddr_print
• SOCKADDR_LEN
• SOCKADDR_STR
• SOCKADDR_PRINT
• tcp_nodelay
• tcp_nopush
• tcp_keepalive
• udp_broadcast
• so_sndtimeo
• so_rcvtimeo

hlog.h

• default_logger
• file_logger
• stderr_logger
• stdout_logger
• logger_create
• logger_destroy
• logger_enable_color
• logger_enable_fsync
• logger_fsync
• logger_print
• logger_set_file
• logger_set_handler
• logger_set_level
• logger_set_max_bufsize
• logger_set_max_filesize
• logger_set_remain_days
• logger_get_cur_file
• hlogd, hlogi, hlogw, hloge, hlogf
• LOGD, LOGI, LOGW, LOGE, LOGF

hbuf.h

• hbuf_t
• offset_buf_t
• HBuf
• HVLBuf
• HRingBuf

hgui.h

• HPoint
• HSize
• HRect

hstring.h

• asprintf
• trim
• trimL
• trimR
• trim_pairs
• split
• splitKV
• replace
• basename
• dirname
• filename
• suffixname
• hv::to_string
• hv::from_string

hfile.h

• class HFile

hdir.h

• listdir

hurl.h

• url_escape
• url_unescape

hscope.h

• defer
• ScopeCleanup
• ScopeFree
• ScopeDelete
• ScopeDeleteArray
• ScopeRelease
• ScopeLock

ifconfig.h

• ifconfig

utils

md5.h

• MD5Init
• MD5Update
• MD5Final

base64.h

• base64_decode
• base64_encode

json.hpp

hmain.h

• main_ctx_init
• parse_opt
• parse_opt_long
• get_arg
• get_env
• setproctitle
• signal_init
• signal_handle
• signal_handler
• create_pidfile
• delete_pidfile
• getpid_form_pidfile
• master_workers_run

singleton.h

• DISABLE_COPY
• SINGLETON_DECL
• SINGLETON_IMPL

event

hloop.h

• create_tcp_client
• create_tcp_server
• create_udp_client
• create_udp_server
• hloop_new
• hloop_free
• hloop_run
• hloop_stop
• hloop_pause
• hloop_resume
• hloop_now
• hloop_now_ms
• hloop_now_hrtime
• hloop_update_time
• hloop_set_userdata
• hloop_userdata
• hloop_post_event
• hevent_loop
• hevent_type
• hevent_id
• hevent_priority
• hevent_userdata
• hevent_set_priority
• hevent_ser_userdata
• haccept
• hconnect
• hread
• hwrite
• hrecv
• hsend
• hrecvfrom
• hsendto
• hio_add
• hio_del
• hio_get
• hio_read
• hio_write
• hio_close
• hio_accept
• hio_connect
• hio_fd
• hio_type
• hio_error
• hio_localaddr
• hio_peeraddr
• hio_setcb_accept
• hio_setcb_connect
• hio_setcb_read
• hio_setcb_write
• hio_setcb_close
• hio_set_localaddr
• hio_set_peeraddr
• hio_set_readbuf
• hio_set_type
• hio_enable_ssl
• htimer_add
• htimer_add_period
• htimer_del
• htimer_reset
• hidle_add
• hidle_del

nlog.h

• network_logger
• nlog_listen

nmap.h

• nmap_discover
• segment_discover
• host_discover

protocol

dns.h

• dns_name_decode
• dns_name_encode
• dns_pack
• dns_unpack
• dns_rr_pack
• dns_rr_unpack
• dns_query
• dns_free
• nslookup

ftp.h

• ftp_command_str
• ftp_connect
• ftp_login
• ftp_exec
• ftp_upload
• ftp_download
• ftp_download_with_cb
• ftp_quit
• ftp_status_str

smtp.h

• smtp_command_str
• smtp_status_str
• smtp_build_command
• sendmail

icmp.h

• ping

http

• HttpMessage
• HttpRequest
• HttpResponse
• HttpParser
• HttpService

httpdef.h

• http_content_type_enum
• http_content_type_enum_by_suffix
• http_content_type_str
• http_content_type_str_by_suffix
• http_content_type_suffix
• http_errno_description
• http_errno_name
• http_method_enum
• http_method_str
• http_status_enum
• http_status_str

http_content.h

• parse_query_params
• parse_json
• parse_multipart
• dump_query_params
• dump_json
• dump_multipart

http_client.h

• http_client_new
• http_client_del
• http_client_send
• http_client_strerror
• http_client_set_timeout
• http_client_set_header
• http_client_del_header
• http_client_get_header
• http_client_clear_headers

HttpServer.h

• http_server_run
• http_server_stop

other

• HVar
• HObject
• HThread
• HThreadPool
• HObjectPool