terminal_listener.h File Reference

Description

Terminal listener.

Object type terminal_listener.

Data Structures
struct	ta_s_event
	Contains event information for asynchronous method calls. More...
struct	ta_s_terminal_listener
	Listener for asynchronous terminal events. More...

Typedefs
typedef struct ta_s_event	ta_s_event_t
	Contains event information for asynchronous method calls.
typedef void(*	ta_cb_terminal_connect_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if a ta_terminal_connect started request finished. More...
typedef void(*	ta_cb_terminal_activate_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_activate_async started request finished. More...
typedef void(*	ta_cb_terminal_application_information_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_application_information_async started request finished. More...
typedef void(*	ta_cb_terminal_balance_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_balance_async started request finished. More...
typedef void(*	ta_cb_terminal_change_settings_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_change_settings_async started request finished. More...
typedef void(*	ta_cb_terminal_commit_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_commit_async started request finished. More...
typedef void(*	ta_cb_terminal_counter_request_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_counter_request_async started request finished. More...
typedef void(*	ta_cb_terminal_deactivate_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_deactivate_async started request finished. More...
typedef void(*	ta_cb_terminal_dcc_rates_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_dcc_rates_async started request finished. More...
typedef void(*	ta_cb_terminal_hardware_information_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_hardware_information_async started request finished. More...
typedef void(*	ta_cb_terminal_init_transaction_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_init_transaction_async started request finished. More...
typedef void(*	ta_cb_terminal_init_transaction_with_dialog_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_init_transaction_with_dialog_async started request finished. More...
typedef void(*	ta_cb_terminal_client_identification_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_client_identification_async started request finished. More...
typedef void(*	ta_cb_terminal_login_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_login_async started request finished. More...
typedef void(*	ta_cb_terminal_logout_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_logout_async started request finished. More...
typedef void(*	ta_cb_terminal_reboot_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_reboot_async started request finished. More...
typedef void(*	ta_cb_terminal_reconciliation_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_reconciliation_async started request finished. More...
typedef void(*	ta_cb_terminal_receipt_request_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_receipt_request_async started request finished. More...
typedef void(*	ta_cb_terminal_transaction_info_request_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_transaction_info_request_async started request finished. More...
typedef void(*	ta_cb_terminal_reconfig_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_reconfig_async started request finished. More...
typedef void(*	ta_cb_terminal_rollback_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_rollback_async started request finished. More...
typedef void(*	ta_cb_terminal_software_update_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_software_update_async started request finished. More...
typedef void(*	ta_cb_terminal_system_information_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_system_information_async started request finished. More...
typedef void(*	ta_cb_terminal_transaction_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_transaction_async started request finished. More...
typedef void(*	ta_cb_terminal_terminal_status_changed) (ta_object_t terminal, void *user_pointer)
	Called if the state of the terminal changed. More...
typedef void(*	ta_cb_terminal_disconnected) (ta_object_t terminal, ta_e_result_code_t result_code, void *user_pointer)
	Connection to terminal closed. More...
typedef void(*	ta_cb_terminal_vas_info) (ta_object_t terminal, ta_object_t vas_checkout_information, void *user_pointer)
	Called if VAS information has been received from the terminal. More...
typedef void(*	ta_cb_terminal_deferred_auth) (ta_object_t terminal, ta_object_t response, void *user_pointer)
	Called if deferred authorization has been received from the terminal. More...
typedef void(*	ta_cb_terminal_key_pressed) (ta_object_t terminal, ta_object_t reason, void *user_pointer)
	Called if key pressed has been received from the terminal. More...
typedef void(*	ta_cb_terminal_license_changed) (ta_object_t terminal, void *user_pointer)
	Called if license changed notification has been received from the terminal. More...
typedef void(*	ta_cb_terminal_screenshot) (ta_object_t terminal, ta_object_t info, void *user_pointer)
	Called if screenshot has been received from the terminal. More...
typedef void(*	ta_cb_terminal_error_notification) (ta_object_t terminal, ta_object_t tim_error, void *user_pointer)
	Called if error notification has been received from the terminal. More...
typedef void(*	ta_cb_terminal_close_reader_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_close_reader_async started request finished. More...
typedef void(*	ta_cb_terminal_open_reader_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_open_reader_async started request finished. More...
typedef void(*	ta_cb_terminal_eject_card_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_eject_card_async started request finished. More...
typedef void(*	ta_cb_terminal_open_maintenance_window_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_open_maintenance_window_async started request finished. More...
typedef void(*	ta_cb_terminal_close_maintenance_window_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_close_maintenance_window_async started request finished. More...
typedef void(*	ta_cb_terminal_activate_service_menu_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_activate_service_menu_async started request finished. More...
typedef void(*	ta_cb_terminal_open_dialog_mode_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_open_dialog_mode_async started request finished. More...
typedef void(*	ta_cb_terminal_close_dialog_mode_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_close_dialog_mode_async started request finished. More...
typedef void(*	ta_cb_terminal_show_signature_capture_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_show_signature_capture_async started request finished. More...
typedef void(*	ta_cb_terminal_show_dialog_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_show_dialog_async started request finished. More...
typedef void(*	ta_cb_terminal_send_card_command_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_send_card_command_async started request finished. More...
typedef void(*	ta_cb_terminal_print_on_terminal_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_print_on_terminal_async started request finished. More...
typedef void(*	ta_cb_terminal_balance_inquiry_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_balance_inquiry_async started request finished. More...
typedef void(*	ta_cb_terminal_loyalty_data_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_loyalty_data_async started request finished. More...
typedef void(*	ta_cb_terminal_start_checkout_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_start_checkout_async started request finished. More...
typedef void(*	ta_cb_terminal_finish_checkout_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_finish_checkout_async started request finished. More...
typedef void(*	ta_cb_terminal_provide_loyalty_basket_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_provide_loyalty_basket_async started request finished. More...
typedef void(*	ta_cb_terminal_provide_vas_result_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_provide_vas_result_async started request finished. More...
typedef void(*	ta_cb_terminal_mobile_topup_issuer_info_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_mobile_topup_issuer_info_async started request finished. More...
typedef void(*	ta_cb_terminal_mobile_topup_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_mobile_topup_async started request finished. More...
typedef void(*	ta_cb_terminal_request_alias_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called if an ta_terminal_request_alias_async started request finished. More...
typedef void(*	ta_cb_terminal_device_maintenance_completed) (const ta_s_event_t *event, void *user_pointer)
	Called if an ta_terminal_device_maintenance_async started request finished. More...
typedef void(*	ta_cb_terminal_request_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called for all completed requests. More...
typedef void(*	ta_cb_terminal_print_receipts) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)
	Called for all requests containing print data. More...
typedef struct ta_s_terminal_listener	ta_s_terminal_listener_t
	Listener for asynchronous terminal events. More...

Functions
ta_e_result_code_t	ta_terminal_listener_create (ta_object_t *listener, const ta_s_terminal_listener_t *configuration)
	Create terminal listener. More...
ta_e_result_code_t	ta_process_print_receipts (ta_object_t terminal, ta_object_t data)
	Process print receipts. More...

Typedef Documentation

ta_cb_terminal_activate_completed

typedef void( * ta_cb_terminal_activate_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_activate_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type activate_response. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_activate_service_menu_completed

typedef void( * ta_cb_terminal_activate_service_menu_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_activate_service_menu_async started request finished.

Supported only if guide unattended is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_application_information_completed

typedef void( * ta_cb_terminal_application_information_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_application_information_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_balance_completed

typedef void( * ta_cb_terminal_balance_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_balance_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type balance_response. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_balance_inquiry_completed

typedef void( * ta_cb_terminal_balance_inquiry_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_balance_inquiry_async started request finished.

Supported only if guide advanced retail is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type balance_inquiry_response. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_change_settings_completed

typedef void( * ta_cb_terminal_change_settings_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_change_settings_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_client_identification_completed

typedef void( * ta_cb_terminal_client_identification_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_client_identification_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type client_identification_response. Object instance is ta_object_invalid if request failed or finished request does not contain client identification data. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_close_dialog_mode_completed

typedef void( * ta_cb_terminal_close_dialog_mode_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_close_dialog_mode_async started request finished.

Supported only if guide dialog is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_close_maintenance_window_completed

typedef void( * ta_cb_terminal_close_maintenance_window_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_close_maintenance_window_async started request finished.

Supported only if guide unattended is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_close_reader_completed

typedef void( * ta_cb_terminal_close_reader_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_close_reader_async started request finished.

Supported only if guide unattended is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_commit_completed

typedef void( * ta_cb_terminal_commit_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_commit_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type print_data. Object instance is ta_object_invalid if request failed or NoPrint mode has been used during login. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_connect_completed

typedef void( * ta_cb_terminal_connect_completed) (const ta_s_event_t *event, void *user_pointer)

Called if a ta_terminal_connect started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_counter_request_completed

typedef void( * ta_cb_terminal_counter_request_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_counter_request_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type counters. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_dcc_rates_completed

typedef void( * ta_cb_terminal_dcc_rates_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_dcc_rates_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type print_data. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_deactivate_completed

typedef void( * ta_cb_terminal_deactivate_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_deactivate_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type deactivate_response. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_deferred_auth

typedef void( * ta_cb_terminal_deferred_auth) (ta_object_t terminal, ta_object_t response, void *user_pointer)

Called if deferred authorization has been received from the terminal.

Parameters

[in]	terminal	Object instance of type terminal. Object instance is not retained.
[in]	response	Object instance of type transaction_response. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_device_maintenance_completed

typedef void( * ta_cb_terminal_device_maintenance_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_device_maintenance_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_disconnected

typedef void( * ta_cb_terminal_disconnected) (ta_object_t terminal, ta_e_result_code_t result_code, void *user_pointer)

Connection to terminal closed.

Called if user disconnected or connection has been lost.

Parameters

[in]	terminal	Object instance of type terminal. Object instance is not retained.
[in]	result_code	Result code.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_eject_card_completed

typedef void( * ta_cb_terminal_eject_card_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_eject_card_async started request finished.

Supported only if guide unattended is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_error_notification

typedef void( * ta_cb_terminal_error_notification) (ta_object_t terminal, ta_object_t tim_error, void *user_pointer)

Called if error notification has been received from the terminal.

Parameters

[in]	terminal	Object instance of type terminal. Object instance is not retained.
[in]	response	Object instance of type tim_error. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_finish_checkout_completed

typedef void( * ta_cb_terminal_finish_checkout_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_finish_checkout_async started request finished.

Supported only if guide value added services is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type vas_checkout_information. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_hardware_information_completed

typedef void( * ta_cb_terminal_hardware_information_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_hardware_information_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type hardware_information_response. Object instance can be ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_init_transaction_completed

typedef void( * ta_cb_terminal_init_transaction_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_init_transaction_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type card_data. Object instance is ta_object_invalid if request failed or finished request does not contain card data. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_init_transaction_with_dialog_completed

typedef void( * ta_cb_terminal_init_transaction_with_dialog_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_init_transaction_with_dialog_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type init_transaction_response. Object instance is ta_object_invalid if request failed or finished request does not contain response data. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_key_pressed

typedef void( * ta_cb_terminal_key_pressed) (ta_object_t terminal, ta_object_t reason, void *user_pointer)

Called if key pressed has been received from the terminal.

Parameters

[in]	terminal	Object instance of type terminal. Object instance is not retained.
[in]	response	Object instance of type integer containing pressed key from enumeration ta_e_reason_t. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_license_changed

typedef void( * ta_cb_terminal_license_changed) (ta_object_t terminal, void *user_pointer)

Called if license changed notification has been received from the terminal.

Deprecated:

Functionality removed.

Parameters

[in]	terminal	Object instance of type terminal. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_login_completed

typedef void( * ta_cb_terminal_login_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_login_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_logout_completed

typedef void( * ta_cb_terminal_logout_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_logout_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_loyalty_data_completed

typedef void( * ta_cb_terminal_loyalty_data_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_loyalty_data_async started request finished.

Supported only if guide value added services is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type card_data. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_mobile_topup_completed

typedef void( * ta_cb_terminal_mobile_topup_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_mobile_topup_async started request finished.

Supported only if guide value added services is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type mobile_topup_data. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_mobile_topup_issuer_info_completed

typedef void( * ta_cb_terminal_mobile_topup_issuer_info_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_mobile_topup_issuer_info_async started request finished.

Supported only if guide value added services is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type list with list elements of type mobile_topup_value. List object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_open_dialog_mode_completed

typedef void( * ta_cb_terminal_open_dialog_mode_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_open_dialog_mode_async started request finished.

Supported only if guide dialog is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_open_maintenance_window_completed

typedef void( * ta_cb_terminal_open_maintenance_window_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_open_maintenance_window_async started request finished.

Supported only if guide unattended is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_open_reader_completed

typedef void( * ta_cb_terminal_open_reader_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_open_reader_async started request finished.

Supported only if guide unattended is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_print_on_terminal_completed

typedef void( * ta_cb_terminal_print_on_terminal_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_print_on_terminal_async started request finished.

Supported only if guide dialog is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_print_receipts

typedef void( * ta_cb_terminal_print_receipts) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called for all requests containing print data.

Convenience method to print all receipts send by the terminal. Contains final receipts to print. If the print data sent to the request completed functions contains fields only ta_terminaL_get_receipt_formatter() is used to create final receipts for printing.

The following request completed methods contain receipts send to this method:

• ta_cb_terminal_activate_completed
• ta_cb_terminal_balance_completed
• ta_cb_terminal_deactivate_completed
• ta_cb_terminal_dcc_rates_completed
• ta_cb_terminal_receipt_request_completed
• ta_cb_terminal_reconciliation_completed
• ta_cb_terminal_reconfig_completed
• ta_cb_terminal_rollback_completed
• ta_cb_terminal_transaction_completed

ta_cb_terminal_print_receipts is called before ta_cb_terminal_request_completed.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type print_data. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_provide_loyalty_basket_completed

typedef void( * ta_cb_terminal_provide_loyalty_basket_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_provide_loyalty_basket_async started request finished.

Supported only if guide value added services is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type list with list elements of type loyalty_item. List object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_provide_vas_result_completed

typedef void( * ta_cb_terminal_provide_vas_result_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_provide_vas_result_async started request finished.

Supported only if guide value added services is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type list with list elements of type loyalty_item. List object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_reboot_completed

typedef void( * ta_cb_terminal_reboot_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_reboot_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_receipt_request_completed

typedef void( * ta_cb_terminal_receipt_request_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_receipt_request_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type receipt_request_response. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_reconciliation_completed

typedef void( * ta_cb_terminal_reconciliation_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_reconciliation_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type reconciliation_response. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_reconfig_completed

typedef void( * ta_cb_terminal_reconfig_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_reconfig_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type print_data. Object instance is ta_object_invalid if request failed or finished request does not contain print data. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_request_alias_completed

typedef void( * ta_cb_terminal_request_alias_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_request_alias_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type string. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_request_completed

typedef void( * ta_cb_terminal_request_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called for all completed requests.

Convience function to get notified about any kind of request having completed.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance with additional data. Object instance is ta_object_invalid if request failed or finished request does not contain additional data. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_rollback_completed

typedef void( * ta_cb_terminal_rollback_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_rollback_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type print_data. Object instance is ta_object_invalid if request failed or finished request does not contain print data. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_screenshot

typedef void( * ta_cb_terminal_screenshot) (ta_object_t terminal, ta_object_t info, void *user_pointer)

Called if screenshot has been received from the terminal.

Parameters

[in]	terminal	Object instance of type terminal. Object instance is not retained.
[in]	info	Object instance of type screenshot_information. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_send_card_command_completed

typedef void( * ta_cb_terminal_send_card_command_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_send_card_command_async started request finished.

Supported only if guide dialog is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type list. Object instance is ta_object_invalid if request failed. Object instance is not retained. Elements in list are of type command_response.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_show_dialog_completed

typedef void( * ta_cb_terminal_show_dialog_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_show_dialog_async started request finished.

Supported only if guide dialog is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type show_dialog_response. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_show_signature_capture_completed

typedef void( * ta_cb_terminal_show_signature_capture_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_show_signature_capture_async started request finished.

Supported only if guide dialog is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type show_signature_capture_response. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_software_update_completed

typedef void( * ta_cb_terminal_software_update_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_software_update_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type integer. Object instance is ta_object_invalid if request failed. Object instance is not retained. Value of integer matches ta_e_update_status_t.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_start_checkout_completed

typedef void( * ta_cb_terminal_start_checkout_completed) (const ta_s_event_t *event, void *user_pointer)

Called if an ta_terminal_start_checkout_async started request finished.

Supported only if guide value added services is enabled.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_system_information_completed

typedef void( * ta_cb_terminal_system_information_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_system_information_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type system_information_response. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_terminal_status_changed

typedef void( * ta_cb_terminal_terminal_status_changed) (ta_object_t terminal, void *user_pointer)

Called if the state of the terminal changed.

Retrieve the state using ta_terminal_get_terminal_state.

Parameters

[in]	terminal	Object instance of type terminal. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_transaction_completed

typedef void( * ta_cb_terminal_transaction_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_transaction_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type transaction_response. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_transaction_info_request_completed

typedef void( * ta_cb_terminal_transaction_info_request_completed) (const ta_s_event_t *event, ta_object_t data, void *user_pointer)

Called if an ta_terminal_transaction_info_request_async started request finished.

Parameters

[in]	event	Pointer to struct containing information about the event.
[in]	data	Object instance of type transaction_info_request_response. Object instance is ta_object_invalid if request failed. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_cb_terminal_vas_info

typedef void( * ta_cb_terminal_vas_info) (ta_object_t terminal, ta_object_t vas_checkout_information, void *user_pointer)

Called if VAS information has been received from the terminal.

Parameters

[in]	terminal	Object instance of type terminal. Object instance is not retained.
[in]	vas_info	Object instance of type vas_checkout_information. Object instance is not retained.
[in]	user_pointer	User pointer value used while creating the listener.

ta_s_terminal_listener_t

typedef struct ta_s_terminal_listener ta_s_terminal_listener_t

Listener for asynchronous terminal events.

Use memset to clear struct to 0. Then set the callbacks you want to use. Callbacks set to 0 are ignored.

This struct is only used to initialize the listener during a call to ta_terminal_listener_create. Afterwards the callbacks can not be changed anymore as long as the listener is alive.

Function Documentation

ta_process_print_receipts()

ta_e_result_code_t ta_process_print_receipts	(	ta_object_t	terminal,
		ta_object_t	data
	)

Process print receipts.

Use this method inside print_receipts in ta_s_terminal_listener_t if you use receipt items. This uses the receipt_formatter set in the terminal instance to format the receipts. Without this method only receipt items will be returned and no receipts.

Parameters

[in]	terminal	Terminal object provided by print_receipts callback.
[in]	data	Print data object provided by print_receipts callback. If ta_object_invalid no processing is done. Otherwise receipt items are processed and placed in data.

Deprecated:

PrintData receipts are formatted by TIM API before send to the listeners. Returns print data unmodified.

ta_terminal_listener_create()

ta_e_result_code_t ta_terminal_listener_create	(	ta_object_t *	listener,
		const ta_s_terminal_listener_t *	configuration
	)

Create terminal listener.

Caller retains a reference to the created instance. While adding to a terminal instance the terminal instance retains the reference. The user can release the reference directly afterwards. In this case the listener is destroyed once no terminal instance requires the listener anymore. The user has to retain the reference to be able to remove the listener from a terminal instance. This allows the listener to be used across different terminal instances.

Parameters

[out]	listener	Pointer to variable to write created object instance to. Created object instance is retained.
[in]	configuration	Pointer to struct containinig listener configuration.

Return values

ta_c_rc_ok	Object instance has been created and written to listener.
ta_c_rc_invalid_argument	listener is null-pointer.
ta_c_rc_invalid_argument	configuration is null-pointer.
ta_c_rc_out_of_memory	Failed allocating memory.