#include <sys/types.h>

#include <ipc/jsobject.h>

#include <exception>

Include dependency graph for libcom3.h:

Data Structures
class	Exception
	Exception type thrown by constructors in classes in this file. More...
class	Milliseconds
class	CommandPipe
class	EventPipe

Namespaces
	vficom
	vficom::cmd
	vficom::cmdparam
	vficom::cmdparam::in
	vficom::cmdparam::in::stk_on
	vficom::cmdparam::in::stk_off
	vficom::cmdparam::in::stk_status
	vficom::cmdparam::in::stk_write
	vficom::cmdparam::in::stk_write::msg
	vficom::cmdparam::in::stk_write::msg::tr
	vficom::cmdparam::in::stk_write::msg::tr::refresh
	vficom::cmdparam::in::stk_write::msg::tr::setup_event_list
	vficom::cmdparam::in::stk_write::msg::tr::select_item
	vficom::cmdparam::in::stk_write::msg::tr::setup_menu
	vficom::cmdparam::in::stk_write::msg::env
	vficom::cmdparam::in::stk_write::msg::env::menu_select
	vficom::cmdparam::in::stk_write::msg::env::event_download
	vficom::cmdparam::in::ussd_write
	vficom::cmdparam::in::ussd_status
	vficom::cmdparam::in::sim_access
	vficom::cmdparam::in::ping
	vficom::cmdparam::out
	vficom::cmdparam::out::ping
	vficom::cmdparam::out::stk_status
	vficom::cmdparam::out::ussd_status
	vficom::cmdparam::out::sim_access
	vficom::cmdparam::out::wlan_scan
	vficom::cmdparam::out::wlan_scan::json_keys
	vficom::event
	vficom::event::stk
	vficom::event::stk::set_up_event_list
	vficom::event::stk::select_item
	vficom::event::stk::menu_selection
	vficom::event::ussd
	vficom::status

Macros
#define	COM3_DllSpec

Enumerations
enum	STKTRCommand { STK_TR_CMD_REFRESH = 1, STK_TR_CMD_SETUP_EVENT_LIST = 5, STK_TR_CMD_SELECT_ITEM = 36, STK_TR_CMD_SETUP_MENU = 37, STK_TR_MAX_ENUM = 0x7FFFFFFF }
enum	STKENVCommand { STK_ENV_CMD_MENU_SELECT = 211, STK_ENV_CMD_EVENT_DOWNLOAD = 214, STK_ENV_MAX_ENUM = 0x7FFFFFFF }
enum	EventType { EVT_URC_STK = 0, EVT_URC_USSD = 1, EVT_MAX_ENUM = 0x7FFFFFFF }
enum	STKURCProCommand { SET_UP_EVENT_LIST = 5, SELECT_ITEM = 36, MENU_SELECTION = 37, STK_URC_PRO_MAX_ENUM = 0x7FFFFFFF }
enum	PipeStatus { OK = 0, INVALID = 1, NOSUPPORT = 2, NOTREADY = 3, FAILED = 5, TIMEOUT = 6, STARVATION = 7, USER_INTERRUPT = 8, MAX_ENUM = 0x7FFFFFFF }

Variables
const COM3_DllSpec char	ping []
	PING command value. More...
const COM3_DllSpec char	stk_on []
	STK On command value. More...
const COM3_DllSpec char	stk_off []
	STK Off command value. More...
const COM3_DllSpec char	stk_status []
	STK Status command value. More...
const COM3_DllSpec char	stk_write []
	STK Write command value. More...
const COM3_DllSpec char	ussd_status []
	USSD Status (AT+CUSD?) More...
const COM3_DllSpec char	ussd_write []
	USSD Write (AT+CUSD=n,str,dcs) More...
const COM3_DllSpec char	sim_access []
	Restricted SIM Access via AT+CRSM. More...
const COM3_DllSpec char	wlan_scan []
	Scan WiFi networks without filtering. More...
const COM3_DllSpec char	command []
	string - JSON member holding one of the command string values defined in vficom::cmd namespace More...
const COM3_DllSpec char	timeout []
	integer - Overall timeout in milliseconds More...
const COM3_DllSpec char	timeout []
	integer - Overall timeout in milliseconds More...
const COM3_DllSpec char	timeout []
	integer - Overall timeout in milliseconds More...
const COM3_DllSpec char	timeout []
	integer - Overall timeout in milliseconds More...
const COM3_DllSpec char	message_obj []
	Object - Parameters depending on STK. More...
const COM3_DllSpec char	usat_command []
	string - "STKTR" or "STKENV" More...
const COM3_DllSpec char	proactCmd []
	integer - STK Cmd (STKTR Command) More...
const COM3_DllSpec char	envCmd []
	integer - STK Cmd (STKENV Command) More...
const COM3_DllSpec char	parameters []
	object - Depends on usat_command and proactCmd/envCmd More...
const COM3_DllSpec char	result []
	integer More...
const COM3_DllSpec char	result []
	integer More...
const COM3_DllSpec char	result []
	integer More...
const COM3_DllSpec char	add_result []
	integer More...
const COM3_DllSpec char	dcs []
	integer More...
const COM3_DllSpec char	hex_string []
	string More...
const COM3_DllSpec char	result []
	integer More...
const COM3_DllSpec char	item_id []
	integer More...
const COM3_DllSpec char	event []
	integer More...
const COM3_DllSpec char	n []
	integer More...
const COM3_DllSpec char	str []
	string, optional More...
const COM3_DllSpec char	dcs []
	int, optional More...
const COM3_DllSpec char	timeout []
	integer - Overall timeout in milliseconds More...
const COM3_DllSpec char	timeout []
	integer - Overall timeout in milliseconds More...
const COM3_DllSpec char	timeout []
	integer - Overall timeout in milliseconds More...
const COM3_DllSpec char	json_cmd []
	string containing the JSON wrapped AT+CRSM command More...
const COM3_DllSpec char	destination []
	string - dns name or ip address More...
const COM3_DllSpec char	count []
	integer - stop after "count" ping request More...
const COM3_DllSpec char	timeout []
	integer - Overall timeout in milliseconds More...
const COM3_DllSpec char	addr_family []
	integer - [optional] value of type com_AddressFamily, default COM_AF_UNSPEC More...
const COM3_DllSpec char	dont_fragment []
	boolean - [optional] set or unset the DF flag in IP header, default (not specified in input command): set automatically based on routing table More...
const COM3_DllSpec char	interface []
	integer - [optional] value of type 'enum com_Interface', default COM_INTERFACE_ANY More...
const COM3_DllSpec char	interval []
	integer - [optional] milliseconds between sending each packet, default: 1000 More...
const COM3_DllSpec char	size []
	integer - [optional] use "size" as number of data bytes to be sent, default 56 More...
const COM3_DllSpec char	waittime []
	integer - [optional] reply wait "waittime" in milliseconds, default 5000 milliseconds More...
const COM3_DllSpec char	comerr []
	contains the status of the command execution: one of com_ErrorCodes More...
const COM3_DllSpec char	transmitted []
	integer - number of transmitted packets More...
const COM3_DllSpec char	received []
	integer - number of received packets More...
const COM3_DllSpec char	rtt_avg []
	integer - avarage RTT in milliseconds More...
const COM3_DllSpec char	rtt_min []
	integer - lowest RTT in milliseconds More...
const COM3_DllSpec char	rtt_max []
	integer - highest RTT in milliseconds More...
const COM3_DllSpec char	status []
	string - returns "on" or "off" More...
const COM3_DllSpec char	status []
	integer - returns 1 or 0 More...
const COM3_DllSpec char	json_resp []
	string containing the JSON wrapped AT+CRSM command response More...
const COM3_DllSpec char	json_resp []
	string containing the JSON array with scan results More...
const COM3_DllSpec char	ssid []
const COM3_DllSpec char	bssid []
	String. More...
const COM3_DllSpec char	adhoc []
	Bool, is the network AdHoc? More...
const COM3_DllSpec char	pairw []
	Int, pairwise cipher, com_WLANCipherTypes. More...
const COM3_DllSpec char	group []
	Int, group cipher, com_WLANCipherTypes. More...
const COM3_DllSpec char	km []
	Int, key management, com_WLANKeyMgmt. More...
const COM3_DllSpec char	perc []
	Int, signal level (percentage) More...
const COM3_DllSpec char	dbm []
	Int, signal level (dBm) More...
const COM3_DllSpec char	freq []
	Int, channel frequency. More...
const COM3_DllSpec char	proto []
	Int, protocol, com_WLANProto. More...
const COM3_DllSpec char	std []
	Int, standard, com_WLANStandard; present only on VOS3. More...
const COM3_DllSpec char	urc []
	string - "+STKPRO:" More...
const COM3_DllSpec char	proactive_command []
	integer (enum STKURCProCommand) - Type of command, for example 5 (SET UP EVENT LIST) More...
const COM3_DllSpec char	parameters []
	object - contains parameters depending on proactive command More...
const COM3_DllSpec char	timeout []
	integer - Timeout in milliseconds More...
const COM3_DllSpec char	event_list []
	integer - EventList, for example 22 More...
const COM3_DllSpec char	cmd_qualifier []
	integer More...
const COM3_DllSpec char	alpha []
	string - Alphanumeric descriptor More...
const COM3_DllSpec char	item_id []
	integer More...
const COM3_DllSpec char	total_items []
	integer More...
const COM3_DllSpec char	item_text []
	string More...
const COM3_DllSpec char	next_action []
	integer More...
const COM3_DllSpec char	default_item []
	integer More...
const COM3_DllSpec char	icon_id []
	integer More...
const COM3_DllSpec char	icon_id_list_elem []
	integer More...
const COM3_DllSpec char	cmd_qualifier []
	integer More...
const COM3_DllSpec char	alpha []
	string - Alphanumeric descriptor More...
const COM3_DllSpec char	item_id []
	integer More...
const COM3_DllSpec char	total_items []
	integer More...
const COM3_DllSpec char	item_text []
	string More...
const COM3_DllSpec char	next_action []
	integer More...
const COM3_DllSpec char	icon_id []
	integer More...
const COM3_DllSpec char	icon_id_list_elem []
	integer More...
const COM3_DllSpec char	m []
	integer More...
const COM3_DllSpec char	str []
	string, optional More...
const COM3_DllSpec char	dcs []
	integer, optional. Must be present if str is set More...

Macro Definition Documentation

◆ COM3_DllSpec

#define COM3_DllSpec

Global eCommerce

In-Person Payments

Business Tools

Petroleum & Convenience

APIs

2Checkout API Reference 6.0

Application Development Kit (Version 4.10)

libcom3.h File Reference

Data Structures

Namespaces

Macros

Enumerations

Variables

Macro Definition Documentation

◆ COM3_DllSpec

Need help?

Not yet a Verifone customer?