> For the complete documentation index, see [llms.txt](https://sandbox-docs.verifone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sandbox-docs.verifone.com/s-adk-5.1-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_a00d4a910169eda6e4cf562ea5c727be/svc__tms_8h.md). # svc\_tms.h [Data Structures](#nested-classes) | [Macros](#define-members) | [Typedefs](#typedef-members) | [Enumerations](#enum-members) | [Functions](#func-members) `#include ` `#include ` `#include "tms_status.h"` Include dependency graph for svc\_tms.h: ![](/files/wFDMEyLWsJZKGkKc9NaN) This graph shows which files directly or indirectly include this file: ![](/files/KJoIzxHMYPpyBMuGkXWo) [Go to the source code of this file.](/s-adk-5.1-programmers-guide/svc__tms_8h_source.md) | | | | --------------- | ------------------------------------------------------------------------ | | Data Structures | | | struct | [version\_t](#structversion__t) | | struct | [tmsReturn](#structtms_return) | | struct | [tmsEventData](#structtms_event_data) | | struct | [tmsAppParameter](#structtms_app_parameter) | | struct | [tmsAppInfo](#structtms_app_info) | | struct | [tmsParamUpdateItemNewStruct](#structtms_param_update_item_new_struct) | | struct | [tmsParamUpdateNewStruct](#structtms_param_update_new_struct) | | struct | [tmsParamUpdateItemStruct](#structtms_param_update_item_struct) | | struct | [tmsParamUpdateStruct](#structtms_param_update_struct) | | struct | [tmsCustomAppEventStruct](#structtms_custom_app_event_struct) | | union | [tmsEventData.notificationData](#uniontms_event_data_8notification_data) | | | | | ------- | ---------------------------------------------------------------------------------------------------- | | Macros | | | #define | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) | | #define | [TMS\_MAX\_APP\_NAME\_LENGTH](#af500378e8be086c754a93d6014483955) 32 | | #define | [TMS\_MAX\_APP\_PARAMETERS](#a1e3ca4dd91955d1834bd6870a8afc96e) 10000 | | #define | [TMS\_MAX\_ADDITIONAL\_INFO](#a8b3aeca1174ae3cd04e06d3b9b9f232e) 256 | | #define | [TMS\_MAX\_STRING\_LENGTH](#ad6392ae2815ca2e77344cfb391b13166) 128 | | #define | [TMS\_STRING\_LENGTH\_64](#a34ca096675e1d15fa34af85dc3b0314c) 64 | | #define | [TMS\_MAX\_REGISTERED\_APPS](#ac8d1ce1f93c7d41105b9eaa7c2eda03a) 32 | | #define | [TMS\_REG\_TIMEOUT\_SECS](#acdbb28360b5227affc2749a99e2d9568) 30 | | #define | [TMS\_STATUS\_SUCCESS](#a5d46eaa0b6bcd2cf1f26428997b1d876) 0 | | #define | [TMS\_STATUS\_ERROR](#ad67eba3a524c068cb8f692887a25ef19) 5000 | | #define | [TMS\_STATUS\_UNSUPPORTED\_FEATURE](#afdb4a37420d73b0d6df4ae7407d1811d) 5001 | | #define | [TMS\_STATUS\_CONTENT\_AVAILABLE](#a276d0b62055e2503c34b9b7685306bc4) 5002 | | #define | [TMS\_STATUS\_NO\_CONSUMER](#a5a5a48611e947173d0376a6b875d3106) 5003 | | #define | [TMS\_STATUS\_FILENAME\_ERROR](#a7e2250702994f5a6234ad7f52532e529) 5004 | | #define | [TMS\_STATUS\_CONTENT\_FAILURE](#a3394ef1baf5eadc7e64528d766ac9d7d) 5005 | | #define | [TMS\_STATUS\_MSGQ\_FAILURE](#ab37b03d1a7f58eeb1bcad77ac6da3760) 5006 | | #define | [TMS\_STATUS\_MSGSND\_FAILURE](#ad33298f089717d63c1d4d4ca200c7cd6) 5007 | | #define | [TMS\_STATUS\_MSGRCV\_FAILURE](#a92f9d8cbb750bc5870deb6790c8d9e64) 5008 | | #define | [TMS\_STATUS\_APP\_EVENT\_AVAIL](#a1c479c9bd6f8ff46ff6ac60abc08e488) 5009 | | #define | [TMS\_STATUS\_REQUESTED](#a42f9cc5077943fa5576f3ef6e8a4b263) 5010 | | #define | [TMS\_STATUS\_REGISTER\_FAIL](#ae792f572fa3d9a9fefd9e4cbc8a50d84) 5011 | | #define | [TMS\_STATUS\_REGISTER\_NAME\_TOO\_LONG](#ac4244dca3389d0413e08c763c1f9b60e) 5012 | | #define | [TMS\_STATUS\_EINVAL](#a2b474faf9b856b3b853753ffa332ff5f) 5013 | | #define | [TMS\_STATUS\_AGENT\_NOT\_RUNNING](#a9fa64b0ef0b1ab93d59ceb1ef0050cc5) 5014 | | #define | [TMS\_STATUS\_SERVER\_INSTANCE\_ERROR](#ac01bafc32c4577e2d0f7d2303f25fc31) 5015 | | #define | [TMS\_STATUS\_SERVER\_INSTANCE\_LOCK\_ERROR](#a65f45877c2b77ba7978c3026f43aa767) 5016 | | #define | [TMS\_STATUS\_SERVER\_INSTANCE\_LOCK\_TIMEOUT\_ERROR](#a80c3881a423feb92b887d3603b4f6826) 5017 | | #define | [TMS\_STATUS\_SERVER\_INSTANCE\_ALREADY\_LOCKED](#a13f1f22565cd5e5ee8be22e7afdae7e9) 5018 | | #define | [TMS\_STATUS\_SERVER\_INSTANCE\_MAX\_LOCK\_REQ\_EXCEEDED](#adb2ea97105e9d8b9ddaea4566989bfd1) 5019 | | #define | [TMS\_STATUS\_SERVER\_INSTANCE\_UNLOCK\_ERROR](#a666e91243b5dfde43122a04e5e24d345) 5020 | | #define | [TMS\_STATUS\_SERVER\_INSTANCE\_CONFIG\_LOAD\_ERROR](#a1d87f4ac487a76ab044867f8699d3531) 5021 | | #define | [TMS\_STATUS\_AGENT\_BUSY\_ERROR](#a0367a9f0590021fb6156da785983ab47) 5022 | | #define | [TMS\_STATUS\_POSTPONED](#a62ed8dd5ef13ff21449ff150f3ba4988) 5023 | | #define | [TMS\_STATUS\_CANCELLED](#a799e83b1a52d9e023b7e035273999a13) 5024 | | #define | [TMS\_STATUS\_AGENT\_CONTACTSRV\_ERROR](#a4b3bf9660b575aaf067e6a70ce960e19) 5025 | | #define | [TMS\_STATUS\_API\_SYNC\_ERROR](#a1e99caa816802f96259cc070b88ec821) 5026 | | #define | [TMS\_STATUS\_HASH\_GEN\_MEMORY\_ERROR](#aa167359fda01826cbc5ba49f720fded0) 5027 | | #define | [TMS\_STATUS\_HASH\_GEN\_VPDX\_ACCESS\_ERROR](#a3a71c16bf9f4be2369c8f2f175f353b9) 5028 | | #define | [TMS\_STATUS\_HASH\_GEN\_DATA\_ACCESS\_ERROR](#a23716206ba0a86110b7cb9e19682bc3a) 5029 | | #define | [TMS\_STATUS\_HASH\_GEN\_FILE\_ACCESS\_ERROR](#a97ecf0e93d11ea6de12a3d20f42f804c) 5030 | | #define | [TMS\_STATUS\_HASH\_GEN\_PARAM\_DOESNT\_EXIST](#a9c63f583ace3438d709c36bccb3f66a5) 5031 | | #define | [TMS\_STATUS\_STRING\_TOO\_LONG](#a0e53cda7168aecc7950ad7278b1b64c0) 5032 | | #define | [TMS\_STATUS\_APP\_IPC\_FAILURE](#a04993658957a880f4a35b8475900bc36) 5033 | | #define | [MAX\_TMS\_FILENAME\_LENGTH](#a2e630fc88638d8cb19648853a846208b) 4096 | | #define | [MAX\_TRANSACTION\_TYPE\_STR\_LEN](#adf877dab92ef7fd5ebdcf1f487b72c63) 128 | | #define | [MAX\_SERVER\_INSTANCE\_NAME\_LEN](#ac954c1213335537d01d968c250154928) 128 | | #define | [MAX\_SERVER\_INSTANCE\_LOCK\_REQ](#a0cd2e54d35b218f0417a377de1f37691) 10 | | #define | [MAX\_SERVER\_INSTANCES](#a1b7722c7099fa5f5437e7bd3f5b8d2a2) 1 | | #define | [PRIMARY\_SERVER\_INSTANCE\_NAME](#af9ce0cfbf24db75b72dc5696f6e0ed68) "primary" | | #define | [TMS\_EVT\_REGISTER\_APP\_RESPONSE](#a80d6bdaf7c7a5839a135532266118533) 1 | | #define | [TMS\_EVT\_UNREGISTER\_APP\_RESPONSE](#a589b38fdc56edaa1c43222ff8b9a6ab8) 2 | | #define | [TMS\_EVT\_CALL\_SERVER\_RESPONSE](#a8eaf8fc5ec6d2b20e07438ca886fd9e3) 3 | | #define | [TMS\_EVT\_GET\_TMS\_CONFIG\_RESPONSE](#a4e7023dbf671604649d8943dc6def024) 4 | | #define | [TMS\_EVT\_SET\_TMS\_CONFIG\_RESPONSE](#aee65166d6e0dfe33212835aa000bb29b) 5 | | #define | [TMS\_EVT\_SET\_APP\_STATE](#adc6db93918eaf20ea27eac21ebb6cb74) 6 | | #define | [TMS\_EVT\_SET\_APP\_INFO](#af5cc86946f9e2d789c8a9fad106fcf12) 7 | | #define | [TMS\_EVT\_SET\_PARM\_LIST](#ae758a5424f567a9bcfb7f897c583aa2a) 8 | | #define | [TMS\_EVT\_GET\_FILE](#abcaba9a047472ff5c377285da7fee48d) 9 | | #define | [TMS\_EVT\_PUT\_FILE](#aeb7924bfa6bb76c8581530b33e385d8d) 10 | | #define | [TMS\_EVT\_DEL\_FILE](#a9e89b94ed25268b89f286d3db27bab3b) 11 | | #define | [TMS\_EVT\_DO\_TRANSACTION](#a14987582765ed6419e9dc74f9a1210d1) 12 | | #define | [TMS\_EVT\_NOTIFICATION](#aadbf0cd512a29bce15c3c2466ace3270) 13 | | #define | [TMS\_EVT\_GET\_SERVER\_INSTANCE](#aa79724f85b66012a0d044420d7251f82) 14 | | #define | [TMS\_EVT\_LOCK\_SERVER\_INSTANCE](#a7ae1a5b068c7a82c8f00af55384a4fbd) 15 | | #define | [TMS\_EVT\_RELEASE\_SERVER\_INSTANCE](#a478231eb52d93437a518616b6a76dead) 16 | | #define | [TMS\_EVT\_APP\_ALERT\_RESULT](#ac014aed9b791092ea060bbdb541940b6) 17 | | #define | [TMS\_EVT\_CLEAR\_APP\_INFO\_RESULT](#aedadc5b0f455a7ebb583d73a84b3caf6) 18 | | #define | [TMS\_EVT\_API\_ERRORS](#a10da76a0d4238eb127df59b22b7cb554) 19 | | #define | [TMS\_EVT\_DELETE\_SERVER\_INSTANCE](#ad191da97bf0915dfe4077c7a647b9b14) 20 | | #define | [TMS\_EVT\_APP\_GENERATED\_PARAM\_UPDATE\_RESULT](#a21646e3177e7ea03cd69916b55e08749) 21 | | #define | [TMS\_EVT\_APP\_ANTI\_SKIMMING\_TEST\_RESULT](#abdce61dbeb0644d4a2e96e680776d969) 22 | | #define | [TMS\_EVT\_APP\_GET\_SW\_UPDATE](#a5d6204b71410515821e94b48827169bb) 23 | | #define | [TMS\_EVT\_GET\_PARM\_FILE](#ac55e805066483ed1a7040382b2d5dbd0) 24 | | #define | [TMS\_PUT\_FILE\_TYPE\_UNSIGNED\_BUNDLE](#aa8048ba3a2ca50a262f1e1fc329a57b3) 1 | | #define | [TMS\_PUT\_FILE\_TYPE\_UNSIGNED\_FILE](#a14b1db18b9ff6a22e15db2dc0b5b4cd0) 2 | | #define | [TMS\_PUT\_FILE\_TYPE\_MIXED\_BUNDLE](#a996bb8ea569d83f47b14910dd84dfb4d) 3 | | #define | [TMS\_PUT\_FILE\_TYPE\_SIGNED\_BUNDLE](#a796d20edc1f653893e54b265a176b88d) 4 | | #define | [TMS\_PUT\_FILE\_TYPE\_FULL\_PARAM\_FILE](#adb8eac114989de601dfc9884f142bac6) 5 | | #define | [TMS\_PUT\_FILE\_TYPE\_PARTIAL\_PARAM\_FILE\_FLAT](#aa331487cbefab1b3879f9406123c61d9) 6 | | #define | [TMS\_PUT\_FILE\_TYPE\_PARTIAL\_PARAM\_FILE\_HIERARCHICAL](#a292f59c7e2efd8f9e464d1bffefb5746) 7 | | #define | [TMS\_PUT\_FILE\_TYPE\_FULL\_PARAM\_FILE\_CONFIG\_SYS](#aafa6b178ff1387467081eb5ea329e15c) 8 | | #define | [TMS\_POST\_INSTALL\_ACTION\_NONE](#a0e933e86cd8a22f0fa04d142aef265aa) 0 | | #define | [TMS\_POST\_INSTALL\_ACTION\_REBOOT](#ae4d58055dfa4f877f43315cfd34d44b4) 1 | | #define | [TMS\_POST\_INSTALL\_ACTION\_RESTART\_APPS](#aaf1dc60352cda5c25c62aca52b6a80be) 3 | | #define | [TMS\_API\_CALL\_SERVER\_UPDATE\_CHECK\_ONLY\_FLAG](#a3e5173444d60c847613fead9de9b95be) 0x1 | | #define | [TMS\_API\_CALL\_SERVER\_FORCE\_MAINTENANCE\_FLAG](#ab11ae2987b7800eed5aa997d91038102) 0x2 | | #define | [TMS\_EVENT\_NOTIFY\_REBOOT\_DEVICE](#a20a62cfaaa5fcd7bc8bf861781f28e06) 0x00000001 | | #define | [TMS\_EVENT\_NOTIFY\_RESTART\_APPS](#a203cc0c5cf9676342d73c83be66bfb19) 0x00000002 | | #define | [TMS\_EVENT\_NOTIFY\_DOWNLOAD\_STARTED](#a7c65fb86818b211a9be7ef91cff90bc2) 0x00000004 | | #define | [TMS\_EVENT\_NOTIFY\_DOWNLOAD\_PERCENT](#a82a24a70b008a4398cd9e60b5b4e61a7) 0x00000008 | | #define | [TMS\_EVENT\_NOTIFY\_DOWNLOAD\_COMPLETE](#a95178c23b255d212e6198d9e83a52528) 0x00000010 | | #define | [TMS\_EVENT\_NOTIFY\_INSTALL\_DOWNLOAD](#ae0cdacb1d3c0716896f020615306b8e7) 0x00000020 | | #define | [TMS\_EVENT\_NOTIFY\_MAINTENANCE\_END](#ae3b27085a5123e469e26690db4934c06) 0x00000040 | | #define | [TMS\_EVENT\_NOTIFY\_HEARTBEAT\_RESULT](#abbbeb0ca332c716875ce723fcb6c8751) 0x00000080 | | #define | [TMS\_EVENT\_NOTIFY\_CONTACT\_SERVER\_START](#af06ff086a6ce10804c2dd5e242961248) 0x00000100 | | #define | [TMS\_EVENT\_NOTIFY\_CONTACT\_SERVER\_END](#a88e7c13320c302b841769e18b456dbbe) 0x00000200 | | #define | [TMS\_EVENT\_NOTIFY\_CONTACT\_SERVER\_APPROVAL](#a35efd85d0d7c068568c13c46309d87b3) 0x00000400 | | #define | [TMS\_EVENT\_NOTIFY\_CONTENT\_UPDATES](#aa2b1dc8828225bbd3e7672afa36381b0) 0x00000800 | | #define | [TMS\_EVENT\_NOTIFY\_CLOCK\_UPDATE](#ae5a507f846c60be7db7af45716531831) 0x00001000 | | #define | [TMS\_EVENT\_NOTIFY\_SERVER\_ERRORS](#a10f49c1abf9054bb30ce5d9141d4b029) 0x00002000 | | #define | [TMS\_EVENT\_NOTIFY\_INSTALL\_STATUS](#a04dcf5e036a224aa142b613c377c767b) 0x00004000 | | #define | [TMS\_EVENT\_NOTIFY\_PROCESSING\_STATUS](#aaae3e579fdc05add1b6870924781d9c0) 0x00008000 | | #define | [TMS\_EVENT\_NOTIFY\_DOWNLOAD\_RETRY](#a6b8370571d0595b6dafadd4169b66bec) 0x00010000 | | #define | [TMS\_EVENT\_NOTIFY\_NETWORK\_ERROR](#a864538682216865a453f1934188cb940) 0x00020000 | | #define | [TMS\_EVENT\_NOTIFY\_DOWNLOAD\_COUNT](#af068f2fc530ea78d6d2df832bb82b1a1) 0x00040000 | | #define | [TMS\_EVENT\_NOTIFY\_GET\_SW\_UPDATE](#a8c3af1f39eafee6cfe3d68fe93ec8207) 0x00080000 | | #define | [TMS\_EVENT\_NOTIFY\_CUSTOM\_APP\_EVENT](#ae5ead2cf77c8bf5b643de2bcdb50d738) 0x00100000 | | #define | [APP\_STATUS\_FREE](#aa14858521210a99f2283adb671c9d529) 1 | | #define | [APP\_STATUS\_BUSY](#a113472ff594a408f71f2aca1f0d252b3) 2 | | #define | [APP\_STATUS\_POSTPONE](#ada0ca969857c9590f5e01b5108d3fc8a) 3 | | #define | [APP\_STATUS\_CANCEL](#aadcff499690e8a331ebd0e09179b2adc) 4 | | #define | [TMS\_PARAMETER\_TYPE\_IDENTIFIER](#aab766abb254cef20f99294b83124c1c5) 0x01 | | #define | [TMS\_PARAMETER\_TYPE\_DEVICE\_PROFILE](#a658a361e715971a74182553127b46a00) 0x02 | | #define | [TMS\_PARAMETER\_TYPE\_DIAGNOSTIC](#aa8a54ebd3d9fd8c26a60e7fc068bf279) 0x04 | | #define | [TMS\_PARAMETER\_TYPE\_VERICENTER](#a790a620cde07ed2d404c8c05b290e573) 0x08 | | #define | [TMS\_MAX\_PARAM\_UPDATE\_COUNT](#ad4aada5fdef16b6836aedbcd2a332a02) 200 | | #define | [TMS\_ALERT\_SEVERITY\_LOW](#a396c03a72aee1d952235d581f4a75c32) 1 | | #define | [TMS\_ALERT\_SEVERITY\_MEDIUM](#a4cc988d1fea1abb5741a88842e020851) 2 | | #define | [TMS\_ALERT\_SEVERITY\_HIGH](#a862e82946cd282092b9d2209ca3e34f8) 3 | | | | | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | Typedefs | | | typedef int(\* | [tmsEventCallback](#a7e46e8ceb49c566a00f9861aedcea595)) (struct [tmsEventData](#structtms_event_data) eventData) | | typedef int(\* | [tmsEventCallback2](#ae733c68b1fd0601ae260976f887c8f70)) (struct [tmsEventData](#structtms_event_data) \*eventData, void \*data) | | typedef enum [\_tms\_apptype](#afb2687e1bbb997a41d362c43bc78ad1c) | [tms\_apptype\_t](#a317e53c1d967d8bf7790a855726aab63) | | typedef int(\* | [tmsSetAppParamHashCB](#ac3c8fefccf99cbf698270564a752d032)) (char \*paramName, char \*paramValue, size\_t paramValueLen) | | | | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enumerations | | | enum |

\_tms\_apptype {
TMS\_APP\_TYPE\_DEFAULT = -1, TMS\_APP\_TYPE\_OS = 0, TMS\_APP\_TYPE\_APPLICATION, TMS\_APP\_TYPE\_SCRIPT,
TMS\_APP\_TYPE\_CP\_APPLICATION, TMS\_APP\_TYPE\_ADK, TMS\_APP\_TYPE\_PAYMENT\_APP, TMS\_APP\_TYPE\_AGENT,
TMS\_APP\_TYPE\_VALUE\_ADD, TMS\_APP\_TYPE\_CUSTOM
}

| | | | | ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Functions | | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [version\_t](#structversion__t) | [tms\_getVersion](#aa0311e37848cc8dcb4551ffc095a64f2) (void) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) char \* | [tms\_GetVersion](#aef3fd695a6bf376370664a65c9b4dcce) (void) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [version\_t](#structversion__t) | [tms\_getAgentVersion](#accdefe74de4de6ab0941d8194413b7fb) (void) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) char \* | [tms\_GetAgentVersion](#a00c6a8f040b3f9167be0a694c2bad68f) (void) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_callServer](#a26d8df025d7b022be3f9bb1334d4aef5) (int secondsToWait) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_callServer2](#a3296d67a3fcea7f399191c69a4d29675) (int secondsToWait, unsigned int iFlags) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_getConfigLocation](#a3889f0d3c64ccf4c76d02c75f0a317b1) (void) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_setNewConfigAvailable](#a3d8613b634236bc3919b51bd2a012beb) (const char \*newTMSConfig) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_setNewConfigAvailableWithTimeout](#a78b45561a55532c8321f2ed92d376f52) (const char \*newTMSConfig, int timeout) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_registerApplication](#a80e68f6d19ff22801c4035b56e34584a) (const char \*appName, int eventNotifyMask, unsigned int tmsEvtCb) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_registerApplication2](#a36c1b6634e739760faa5a90d0d736c6e) (const char \*appName, int eventNotifyMask, [tmsEventCallback2](#ae733c68b1fd0601ae260976f887c8f70) tmsEvtCb, void \*cbData) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_registerApplication3](#ae0eef17fbaa833d545265a6be4ebab8d) (const char \*appName, const char \*appVersion, [tms\_apptype\_t](#a317e53c1d967d8bf7790a855726aab63) appType, const char \*appCustomType, const char \*additionalInfo, int eventNotifyMask, [tmsEventCallback2](#ae733c68b1fd0601ae260976f887c8f70) tmsEvtCb, void \*cbData) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_unregisterApplication](#abbf7093195d07880b5e7c897b3b1038a) (const char \*appName) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) int | [tms\_setApplicationState](#a3c19eb8469c9bad6ee2ed24a8251ecc1) (int handle, int appState) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) int | [tms\_setApplicationInfo](#a6d90f3cbfab83a83607d2f2f933b31f9) (int handle, struct [tmsAppInfo](#structtms_app_info) appInfo) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_clearApplicationInfo](#acf80be83f363195d99b03502f3afce14) (void) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) int | [tms\_setApplicationParameterList](#abac6a5f355198c4120c670316a871a98) (int handle, int numParamFiles, const char \*paramInfoFile) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) int | [tms\_setApplicationParameterHash](#aec879c2e664d10594fd1e980dc27ad20) (int handle, const char \*paramDefFile, [tmsSetAppParamHashCB](#ac3c8fefccf99cbf698270564a752d032) paramDataCb) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) int | [tms\_sendParameterUpdateCallback](#a21bb04876b23c2af4fd540d30a1b6338) (int handle, struct [tmsParamUpdateNewStruct](#structtms_param_update_new_struct) \*parameterUpdates) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_sendParameterUpdate](#a2ac3ee1e9e890633e9008256406dc0b2) (struct [tmsParamUpdateStruct](#structtms_param_update_struct) \*parameterUpdates) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) int | [tms\_getApplicationFileAvailable](#a813a8a0248fa17ad7cca794f9e897afd) (int handle, int result, const char \*fileLocation, unsigned char [removeFile](/s-adk-5.1-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_8067e1b9d01c079cf22ff7672b5922b3/_v_h_q_utils__shared_8c.md#a5b036df1be1ec3c95ce8a57692e2b8c8)) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) int | [tms\_setFileOperationResult](#a7e372540b1a86e2176568d43e73977fa) (int handle, int fileOpResult, int fileOpType) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) int | [tms\_setFileOperationResultWithDescription](#af2fe4965261900c31406ff287c4acecb) (int handle, int fileOpResult, int fileOpType, char \*additional\_info) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) int | [tms\_setTransactionResult](#a66adafdd340cc6ecd136ac51fc00d4ce) (int handle, int transactionResult) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_getServerInstance](#a0b68adfe3e85ea9fb8e7ed19a9697dc1) (void) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_lockServerInstance](#a0916061b6320bf65d5d1e9b04c32f574) (char \*instanceId, int mlSecTimeout) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_releaseServerLock](#ad6387ab34756d72bb79c20682d8a0366) (char \*restoreInstanceId) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_deleteServerInstance](#afa9841ae7b688a05c672242c853204c4) (char \*deleteInstanceId) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_sendApplicationAlert](#aab41635bf3606adbcfa491bd6390b374) (char \*description, int severity, char \*details) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_sendCustomAppEvent](#ac74f8ff212d11be3aa1cae170aadf3d6) (char \*appName, char \*description, char \*details) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_sendCustomAppEvent2](#ae0bf2b5e7528a563fee957b80c6c62fa) (struct [tmsCustomAppEventStruct](#structtms_custom_app_event_struct) \*appEvent) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_blgetPOSAgetnInfo](#a39393c0fae6f7329a4f307455c5a5c16) (char \*buffer, unsigned int size) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) bool | [tms\_idsMode](#a48874555ddb56a929d6dc619aed21ab5) (void) | | [TMS\_API](#aed564c0d7f8be3217e05a223cac4921e) struct [tmsReturn](#structtms_return) | [tms\_getUpdates](#ae10994ec1353d5b7856b5965a630c8da) (const char \*updateType, const char \*software, const char \*reference) | *** ### DataStructure Documentation ### version\_t struct version\_t | | | | | ----------- | ---------- | -------------------------------- | | Data Fields | | | | char | build\[16] | Optional build string (i.e. rc1) | | int | hotfix | Hotfix Version | | int | maint | Maintenance Version | | int | major | Major Version | | int | minor | Minor Version | ### tmsReturn struct tmsReturn The structure returned in response to some TMS APIs. This structure is returned when communication with the TMS Agent is required and an immediate response may not be available. In these cases, the status field will indicate TMS\_STATUS\_REQUESTED, and the handle will be used to track the ultimate response from the TMS Agent. When the agent is able to respond to the request, it will send the response in a [tmsEventData](#structtms_event_data) structure with the handle of that structure set to the same value as the handle returned in this structure. | | | | | ----------- | ------ | -------------------------------------------------------------------------------------------------------- | | Data Fields | | | | int | handle | Handle for tracking purposes - valid handle is > 0 | | int | status | Return state value - TMS\_STATUS\_REQUESTED indicates the request was successfully made to the TMS Agent | ### tmsEventData struct tmsEventData The TMS [Event](/s-adk-5.1-programmers-guide/readme/files/dir_1e776ad494434554ed2e1a73460819d8/dir_dc5dfd6157a1d65d3f69cd65a617f88c/libevt_8h.md#struct_event) structure that needs to be handled by the callback function provided in the applications [tms\_registerApplication()](#a80e68f6d19ff22801c4035b56e34584a) call. The strcuture has detailed information about the events that the application gets notified of. | | | | | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | Data Fields | | | | int | appStatus | status of application in response to TMS\_EVT\_SET\_APP\_STATE request | | int | eventMask | mask of events for TMS\_EVT\_NOTIFICATION event | | int | evtType | type of event | | char | filename\[[MAX\_TMS\_FILENAME\_LENGTH](#a2e630fc88638d8cb19648853a846208b)] | filename to process (may be empty) - used for TMS\_EVT\_GET\_FILE, TMS\_EVT\_PUT\_FILE and TMS\_EVT\_DEL\_FILE events | | char | filepath\[[MAX\_TMS\_FILENAME\_LENGTH](#a2e630fc88638d8cb19648853a846208b)] | Path where the file will go (may be empty) - used for TMS\_EVT\_GET\_FILE, TMS\_EVT\_PUT\_FILE and TMS\_EVT\_DEL\_FILE events | | int | handle | a handle that can be used for tracking purposes - gets passed back in certain response functions | | union [tmsEventData](#uniontms_event_data_8notification_data) | notificationData | | | int | numFileEntries | number of entries in a file (applies to TMS\_EVT\_SET\_APP\_INFO/TMS\_EVT\_SET\_PARM\_LIST response) | | int | putFileType | type of file to process for TMS\_EVT\_PUT\_FILE events | | unsigned char | removeFile | whether to remove file after it is received by the agent (applies to TMS\_EVT\_GET\_FILE response) | | int | status | status of the event | | char | transactionType\[[MAX\_TRANSACTION\_TYPE\_STR\_LEN](#adf877dab92ef7fd5ebdcf1f487b72c63)] | type of transaction to perform in TMS\_EVT\_DO\_TRANSACTION event | ### tmsAppParameter struct tmsAppParameter Application Parameter Structure used by the application to pass an application parameter to TMS. The application will setup one of these structures for each custom parameter it would like sent to the TMS server. An array of these structures is then pointed to in the [tmsAppInfo](#structtms_app_info) structure that gets passed to [tms\_setApplicationInfo()](#a6d90f3cbfab83a83607d2f2f933b31f9) in response to a TMS\_EVT\_SET\_APP\_INFO event. | | | | | ----------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | Data Fields | | | | char | parameterName\[64] | NULL terminated parameter name - i.e. "DeviceId" for VX terminals | | int | parameterType | Parameter type (i.e. TMS\_PARAMETER\_TYPE\_IDENTIFIER, TMS\_PARAMETER\_TYPE\_DEVICE\_PROFILE, or TMS\_PARAMETER\_TYPE\_DIAGNOSTIC) | | char | parameterValue\[256] | NULL terminated parameter Value - i.e. Device ID value for VX terminals | ### tmsAppInfo struct tmsAppInfo Application Information Structure used by the application to pass application parameters to TMS. This structure is filled out by the application and passed to [tms\_setApplicationInfo()](#a6d90f3cbfab83a83607d2f2f933b31f9) in response to a TMS\_EVT\_SET\_APP\_INFO event. Collaboration diagram for tmsAppInfo: ![Collaboration graph](/files/oLt0CCjja80SBfgrtmqX) \[[legend](/s-adk-5.1-programmers-guide/graph_legend.md)] | | | | | ----------------------------------------------------- | -------------- | ----------------------------------------------------------------------------------------------------- | | Data Fields | | | | int | parameterCount | number of [tmsAppParameter](#structtms_app_parameter) values in the parameterList array | | struct [tmsAppParameter](#structtms_app_parameter) \* | parameterList | Pointer to an array of [tmsAppParameter](#structtms_app_parameter)\[] values to be sent to the server | ### tmsParamUpdateItemNewStruct struct tmsParamUpdateItemNewStruct | | | | | ---------------------------------------------------------- | ---------------- | - | | Data Fields | | | | char | Application\[64] | | | char | Container\[1024] | | | char | Name\[256] | | | [tmsSetAppParamHashCB](#ac3c8fefccf99cbf698270564a752d032) | ParamDataCb | | | const char \* | ParamDefFile | | | char | Value\[256] | | | char | version\[32] | | ### tmsParamUpdateNewStruct struct tmsParamUpdateNewStruct Collaboration diagram for tmsParamUpdateNewStruct: ![Collaboration graph](/files/GgmqXVdGZgjtSWEB8Qz1) \[[legend](/s-adk-5.1-programmers-guide/graph_legend.md)] | | | | | -------------------------------------------------------------------------------- | ---------------- | - | | Data Fields | | | | int | paramUpdateCount | | | struct [tmsParamUpdateItemNewStruct](#structtms_param_update_item_new_struct) \* | paramUpdateList | | ### tmsParamUpdateItemStruct struct tmsParamUpdateItemStruct | | | | | ---------------------------------------------------------- | ---------------- | - | | Data Fields | | | | char | Application\[64] | | | char | Container\[1024] | | | char | Name\[256] | | | [tmsSetAppParamHashCB](#ac3c8fefccf99cbf698270564a752d032) | ParamDataCb | | | const char \* | ParamDefFile | | | char | Value\[256] | | ### tmsParamUpdateStruct struct tmsParamUpdateStruct Collaboration diagram for tmsParamUpdateStruct: ![Collaboration graph](/files/yIRIxP93T7C9kkmJDPTr) \[[legend](/s-adk-5.1-programmers-guide/graph_legend.md)] | | | | | ------------------------------------------------------------------------- | ---------------- | - | | Data Fields | | | | int | paramUpdateCount | | | struct [tmsParamUpdateItemStruct](#structtms_param_update_item_struct) \* | paramUpdateList | | ### tmsCustomAppEventStruct struct tmsCustomAppEventStruct | | | | | ----------- | ----------------------------------------------------------------------------------- | - | | Data Fields | | | | char | additional\_info\[[TMS\_MAX\_ADDITIONAL\_INFO](#a8b3aeca1174ae3cd04e06d3b9b9f232e)] | | | char | appName\[[TMS\_MAX\_APP\_NAME\_LENGTH](#af500378e8be086c754a93d6014483955)] | | | char | eventName\[[TMS\_STRING\_LENGTH\_64](#a34ca096675e1d15fa34af85dc3b0314c)] | | ### tmsEventData.notificationData union tmsEventData.notificationData | | | | | ----------- | -------------------- | ---------------------------------------------------------------------------------------------------------------- | | Data Fields | | | | int | downloadCompletedCnt | Count of Downloads that are completed | | int | downloadCount | Downloadfile Operation type count in a Management Plan | | int | downloadPercent | percentage of download that is complete for TMS\_EVT\_NOTIFICATION / TMS\_EVENT\_NOTIFY\_DOWNLOAD\_PERCENT event | | int | downloadRetryCnt | Download retry count | | int | downloadStartCnt | Count of Downloads that are started | | int | installCompletedCnt | Count of Installs that are completed | | int | installStartCnt | Count of Installs that are started | ### MacroDefinition Documentation ### APP\_STATUS\_BUSY \#define APP\_STATUS\_BUSY 2 ### APP\_STATUS\_CANCEL \#define APP\_STATUS\_CANCEL 4 ### APP\_STATUS\_FREE \#define APP\_STATUS\_FREE 1 ### APP\_STATUS\_POSTPONE \#define APP\_STATUS\_POSTPONE 3 ### MAX\_SERVER\_INSTANCE\_LOCK\_REQ \#define MAX\_SERVER\_INSTANCE\_LOCK\_REQ 10 ### MAX\_SERVER\_INSTANCE\_NAME\_LEN \#define MAX\_SERVER\_INSTANCE\_NAME\_LEN 128 ### MAX\_SERVER\_INSTANCES \#define MAX\_SERVER\_INSTANCES 1 ### MAX\_TMS\_FILENAME\_LENGTH \#define MAX\_TMS\_FILENAME\_LENGTH 4096 ### MAX\_TRANSACTION\_TYPE\_STR\_LEN \#define MAX\_TRANSACTION\_TYPE\_STR\_LEN 128 ### PRIMARY\_SERVER\_INSTANCE\_NAME \#define PRIMARY\_SERVER\_INSTANCE\_NAME \\"primary\\" ### TMS\_ALERT\_SEVERITY\_HIGH \#define TMS\_ALERT\_SEVERITY\_HIGH 3 ### TMS\_ALERT\_SEVERITY\_LOW \#define TMS\_ALERT\_SEVERITY\_LOW 1 ### TMS\_ALERT\_SEVERITY\_MEDIUM \#define TMS\_ALERT\_SEVERITY\_MEDIUM 2 ### TMS\_API \#define TMS\_API ### TMS\_API\_CALL\_SERVER\_FORCE\_MAINTENANCE\_FLAG \#define TMS\_API\_CALL\_SERVER\_FORCE\_MAINTENANCE\_FLAG 0x2 ### TMS\_API\_CALL\_SERVER\_UPDATE\_CHECK\_ONLY\_FLAG \#define TMS\_API\_CALL\_SERVER\_UPDATE\_CHECK\_ONLY\_FLAG 0x1 ### TMS\_EVENT\_NOTIFY\_CLOCK\_UPDATE \#define TMS\_EVENT\_NOTIFY\_CLOCK\_UPDATE 0x00001000 ### TMS\_EVENT\_NOTIFY\_CONTACT\_SERVER\_APPROVAL \#define TMS\_EVENT\_NOTIFY\_CONTACT\_SERVER\_APPROVAL 0x00000400 ### TMS\_EVENT\_NOTIFY\_CONTACT\_SERVER\_END \#define TMS\_EVENT\_NOTIFY\_CONTACT\_SERVER\_END 0x00000200 ### TMS\_EVENT\_NOTIFY\_CONTACT\_SERVER\_START \#define TMS\_EVENT\_NOTIFY\_CONTACT\_SERVER\_START 0x00000100 ### TMS\_EVENT\_NOTIFY\_CONTENT\_UPDATES \#define TMS\_EVENT\_NOTIFY\_CONTENT\_UPDATES 0x00000800 ### TMS\_EVENT\_NOTIFY\_CUSTOM\_APP\_EVENT \#define TMS\_EVENT\_NOTIFY\_CUSTOM\_APP\_EVENT 0x00100000 ### TMS\_EVENT\_NOTIFY\_DOWNLOAD\_COMPLETE \#define TMS\_EVENT\_NOTIFY\_DOWNLOAD\_COMPLETE 0x00000010 ### TMS\_EVENT\_NOTIFY\_DOWNLOAD\_COUNT \#define TMS\_EVENT\_NOTIFY\_DOWNLOAD\_COUNT 0x00040000 ### TMS\_EVENT\_NOTIFY\_DOWNLOAD\_PERCENT \#define TMS\_EVENT\_NOTIFY\_DOWNLOAD\_PERCENT 0x00000008 ### TMS\_EVENT\_NOTIFY\_DOWNLOAD\_RETRY \#define TMS\_EVENT\_NOTIFY\_DOWNLOAD\_RETRY 0x00010000 ### TMS\_EVENT\_NOTIFY\_DOWNLOAD\_STARTED \#define TMS\_EVENT\_NOTIFY\_DOWNLOAD\_STARTED 0x00000004 ### TMS\_EVENT\_NOTIFY\_GET\_SW\_UPDATE \#define TMS\_EVENT\_NOTIFY\_GET\_SW\_UPDATE 0x00080000 ### TMS\_EVENT\_NOTIFY\_HEARTBEAT\_RESULT \#define TMS\_EVENT\_NOTIFY\_HEARTBEAT\_RESULT 0x00000080 ### TMS\_EVENT\_NOTIFY\_INSTALL\_DOWNLOAD \#define TMS\_EVENT\_NOTIFY\_INSTALL\_DOWNLOAD 0x00000020 ### TMS\_EVENT\_NOTIFY\_INSTALL\_STATUS \#define TMS\_EVENT\_NOTIFY\_INSTALL\_STATUS 0x00004000 ### TMS\_EVENT\_NOTIFY\_MAINTENANCE\_END \#define TMS\_EVENT\_NOTIFY\_MAINTENANCE\_END 0x00000040 ### TMS\_EVENT\_NOTIFY\_NETWORK\_ERROR \#define TMS\_EVENT\_NOTIFY\_NETWORK\_ERROR 0x00020000 ### TMS\_EVENT\_NOTIFY\_PROCESSING\_STATUS \#define TMS\_EVENT\_NOTIFY\_PROCESSING\_STATUS 0x00008000 ### TMS\_EVENT\_NOTIFY\_REBOOT\_DEVICE \#define TMS\_EVENT\_NOTIFY\_REBOOT\_DEVICE 0x00000001 ### TMS\_EVENT\_NOTIFY\_RESTART\_APPS \#define TMS\_EVENT\_NOTIFY\_RESTART\_APPS 0x00000002 ### TMS\_EVENT\_NOTIFY\_SERVER\_ERRORS \#define TMS\_EVENT\_NOTIFY\_SERVER\_ERRORS 0x00002000 ### TMS\_EVT\_API\_ERRORS \#define TMS\_EVT\_API\_ERRORS 19 ### TMS\_EVT\_APP\_ALERT\_RESULT \#define TMS\_EVT\_APP\_ALERT\_RESULT 17 ### TMS\_EVT\_APP\_ANTI\_SKIMMING\_TEST\_RESULT \#define TMS\_EVT\_APP\_ANTI\_SKIMMING\_TEST\_RESULT 22 [Event](/s-adk-5.1-programmers-guide/readme/files/dir_1e776ad494434554ed2e1a73460819d8/dir_dc5dfd6157a1d65d3f69cd65a617f88c/libevt_8h.md#struct_event) sent by the agent to notify the application of Anti-skimming results called using [`tms_sendCustomAppEvent()`](#ac74f8ff212d11be3aa1cae170aadf3d6) ### TMS\_EVT\_APP\_GENERATED\_PARAM\_UPDATE\_RESULT \#define TMS\_EVT\_APP\_GENERATED\_PARAM\_UPDATE\_RESULT 21 This event is for responses to app parameter updates ### TMS\_EVT\_APP\_GET\_SW\_UPDATE \#define TMS\_EVT\_APP\_GET\_SW\_UPDATE 23 [Event](/s-adk-5.1-programmers-guide/readme/files/dir_1e776ad494434554ed2e1a73460819d8/dir_dc5dfd6157a1d65d3f69cd65a617f88c/libevt_8h.md#struct_event) sent by the agent to notify the application if Get Sw Update called using [`tms_getUpdates()`](#ae10994ec1353d5b7856b5965a630c8da) ### TMS\_EVT\_CALL\_SERVER\_RESPONSE \#define TMS\_EVT\_CALL\_SERVER\_RESPONSE 3 ### TMS\_EVT\_CLEAR\_APP\_INFO\_RESULT \#define TMS\_EVT\_CLEAR\_APP\_INFO\_RESULT 18 ### TMS\_EVT\_DEL\_FILE \#define TMS\_EVT\_DEL\_FILE 11 ### TMS\_EVT\_DELETE\_SERVER\_INSTANCE \#define TMS\_EVT\_DELETE\_SERVER\_INSTANCE 20 ### TMS\_EVT\_DO\_TRANSACTION \#define TMS\_EVT\_DO\_TRANSACTION 12 ### TMS\_EVT\_GET\_FILE \#define TMS\_EVT\_GET\_FILE 9 ### TMS\_EVT\_GET\_PARM\_FILE \#define TMS\_EVT\_GET\_PARM\_FILE 24 ### TMS\_EVT\_GET\_SERVER\_INSTANCE \#define TMS\_EVT\_GET\_SERVER\_INSTANCE 14 ### TMS\_EVT\_GET\_TMS\_CONFIG\_RESPONSE \#define TMS\_EVT\_GET\_TMS\_CONFIG\_RESPONSE 4 ### TMS\_EVT\_LOCK\_SERVER\_INSTANCE \#define TMS\_EVT\_LOCK\_SERVER\_INSTANCE 15 ### TMS\_EVT\_NOTIFICATION \#define TMS\_EVT\_NOTIFICATION 13 ### TMS\_EVT\_PUT\_FILE \#define TMS\_EVT\_PUT\_FILE 10 ### TMS\_EVT\_REGISTER\_APP\_RESPONSE \#define TMS\_EVT\_REGISTER\_APP\_RESPONSE 1 ### TMS\_EVT\_RELEASE\_SERVER\_INSTANCE \#define TMS\_EVT\_RELEASE\_SERVER\_INSTANCE 16 ### TMS\_EVT\_SET\_APP\_INFO \#define TMS\_EVT\_SET\_APP\_INFO 7 ### TMS\_EVT\_SET\_APP\_STATE \#define TMS\_EVT\_SET\_APP\_STATE 6 ### TMS\_EVT\_SET\_PARM\_LIST \#define TMS\_EVT\_SET\_PARM\_LIST 8 ### TMS\_EVT\_SET\_TMS\_CONFIG\_RESPONSE \#define TMS\_EVT\_SET\_TMS\_CONFIG\_RESPONSE 5 ### TMS\_EVT\_UNREGISTER\_APP\_RESPONSE \#define TMS\_EVT\_UNREGISTER\_APP\_RESPONSE 2 ### TMS\_MAX\_ADDITIONAL\_INFO \#define TMS\_MAX\_ADDITIONAL\_INFO 256 ### TMS\_MAX\_APP\_NAME\_LENGTH \#define TMS\_MAX\_APP\_NAME\_LENGTH 32 ### TMS\_MAX\_APP\_PARAMETERS \#define TMS\_MAX\_APP\_PARAMETERS 10000 ### TMS\_MAX\_PARAM\_UPDATE\_COUNT \#define TMS\_MAX\_PARAM\_UPDATE\_COUNT 200 ### TMS\_MAX\_REGISTERED\_APPS \#define TMS\_MAX\_REGISTERED\_APPS 32 ### TMS\_MAX\_STRING\_LENGTH \#define TMS\_MAX\_STRING\_LENGTH 128 ### TMS\_PARAMETER\_TYPE\_DEVICE\_PROFILE \#define TMS\_PARAMETER\_TYPE\_DEVICE\_PROFILE 0x02 a parameter to send with device profile information ### TMS\_PARAMETER\_TYPE\_DIAGNOSTIC \#define TMS\_PARAMETER\_TYPE\_DIAGNOSTIC 0x04 a parameter to send with diagnostic information ### TMS\_PARAMETER\_TYPE\_IDENTIFIER \#define TMS\_PARAMETER\_TYPE\_IDENTIFIER 0x01 a parameter to send with identifier information ### TMS\_PARAMETER\_TYPE\_VERICENTER \#define TMS\_PARAMETER\_TYPE\_VERICENTER 0x08 a parameter to send with diagnostic information ### TMS\_POST\_INSTALL\_ACTION\_NONE \#define TMS\_POST\_INSTALL\_ACTION\_NONE 0 ### TMS\_POST\_INSTALL\_ACTION\_REBOOT \#define TMS\_POST\_INSTALL\_ACTION\_REBOOT 1 ### TMS\_POST\_INSTALL\_ACTION\_RESTART\_APPS \#define TMS\_POST\_INSTALL\_ACTION\_RESTART\_APPS 3 ### TMS\_PUT\_FILE\_TYPE\_FULL\_PARAM\_FILE \#define TMS\_PUT\_FILE\_TYPE\_FULL\_PARAM\_FILE 5 a full parameter file type ### TMS\_PUT\_FILE\_TYPE\_FULL\_PARAM\_FILE\_CONFIG\_SYS \#define TMS\_PUT\_FILE\_TYPE\_FULL\_PARAM\_FILE\_CONFIG\_SYS 8 a full parameter file type, automatically merged into the environment ### TMS\_PUT\_FILE\_TYPE\_MIXED\_BUNDLE \#define TMS\_PUT\_FILE\_TYPE\_MIXED\_BUNDLE 3 a mixed bundle type (unsigned and signed packages) ### TMS\_PUT\_FILE\_TYPE\_PARTIAL\_PARAM\_FILE\_FLAT \#define TMS\_PUT\_FILE\_TYPE\_PARTIAL\_PARAM\_FILE\_FLAT 6 a flat partial parameter file type ### TMS\_PUT\_FILE\_TYPE\_PARTIAL\_PARAM\_FILE\_HIERARCHICAL \#define TMS\_PUT\_FILE\_TYPE\_PARTIAL\_PARAM\_FILE\_HIERARCHICAL 7 a hierarchical partial parameter file type ### TMS\_PUT\_FILE\_TYPE\_SIGNED\_BUNDLE \#define TMS\_PUT\_FILE\_TYPE\_SIGNED\_BUNDLE 4 a signed bundle type ### TMS\_PUT\_FILE\_TYPE\_UNSIGNED\_BUNDLE \#define TMS\_PUT\_FILE\_TYPE\_UNSIGNED\_BUNDLE 1 an unsigned bundle type ### TMS\_PUT\_FILE\_TYPE\_UNSIGNED\_FILE \#define TMS\_PUT\_FILE\_TYPE\_UNSIGNED\_FILE 2 a single unsigned file ### TMS\_REG\_TIMEOUT\_SECS \#define TMS\_REG\_TIMEOUT\_SECS 30 ### TMS\_STATUS\_AGENT\_BUSY\_ERROR \#define TMS\_STATUS\_AGENT\_BUSY\_ERROR 5022 agent is busy and can't perform request ### TMS\_STATUS\_AGENT\_CONTACTSRV\_ERROR \#define TMS\_STATUS\_AGENT\_CONTACTSRV\_ERROR 5025 vhq server doesn't ready to process requests from device yet ### TMS\_STATUS\_AGENT\_NOT\_RUNNING \#define TMS\_STATUS\_AGENT\_NOT\_RUNNING 5014 the agent is not running ### TMS\_STATUS\_API\_SYNC\_ERROR \#define TMS\_STATUS\_API\_SYNC\_ERROR 5026 app and Agent lost sync in messages ### TMS\_STATUS\_APP\_EVENT\_AVAIL \#define TMS\_STATUS\_APP\_EVENT\_AVAIL 5009 app event is available ### TMS\_STATUS\_APP\_IPC\_FAILURE \#define TMS\_STATUS\_APP\_IPC\_FAILURE 5033 Connection interrupted or eof ### TMS\_STATUS\_CANCELLED \#define TMS\_STATUS\_CANCELLED 5024 vhq got the request to cancel current task ### TMS\_STATUS\_CONTENT\_AVAILABLE \#define TMS\_STATUS\_CONTENT\_AVAILABLE 5002 content available status ### TMS\_STATUS\_CONTENT\_FAILURE \#define TMS\_STATUS\_CONTENT\_FAILURE 5005 content failed to update ### TMS\_STATUS\_EINVAL \#define TMS\_STATUS\_EINVAL 5013 error in a parameter value ### TMS\_STATUS\_ERROR \#define TMS\_STATUS\_ERROR 5000 error status ### TMS\_STATUS\_FILENAME\_ERROR \#define TMS\_STATUS\_FILENAME\_ERROR 5004 filename is too long ### TMS\_STATUS\_HASH\_GEN\_DATA\_ACCESS\_ERROR \#define TMS\_STATUS\_HASH\_GEN\_DATA\_ACCESS\_ERROR 5029 error occured accessing data from app data retrieval callback ### TMS\_STATUS\_HASH\_GEN\_FILE\_ACCESS\_ERROR \#define TMS\_STATUS\_HASH\_GEN\_FILE\_ACCESS\_ERROR 5030 error occured accessing temporary file to store parameter information ### TMS\_STATUS\_HASH\_GEN\_MEMORY\_ERROR \#define TMS\_STATUS\_HASH\_GEN\_MEMORY\_ERROR 5027 memory error (i.e. malloc failure) occured generating hash values from VPDX ### TMS\_STATUS\_HASH\_GEN\_PARAM\_DOESNT\_EXIST \#define TMS\_STATUS\_HASH\_GEN\_PARAM\_DOESNT\_EXIST 5031 App will use this to tell agent that a parameter doesn't exist in the container ### TMS\_STATUS\_HASH\_GEN\_VPDX\_ACCESS\_ERROR \#define TMS\_STATUS\_HASH\_GEN\_VPDX\_ACCESS\_ERROR 5028 error occured opening or accessing VPDX ### TMS\_STATUS\_MSGQ\_FAILURE \#define TMS\_STATUS\_MSGQ\_FAILURE 5006 message queue failure ### TMS\_STATUS\_MSGRCV\_FAILURE \#define TMS\_STATUS\_MSGRCV\_FAILURE 5008 receiving message from TMS agent failed ### TMS\_STATUS\_MSGSND\_FAILURE \#define TMS\_STATUS\_MSGSND\_FAILURE 5007 sending message to TMS agent failed ### TMS\_STATUS\_NO\_CONSUMER \#define TMS\_STATUS\_NO\_CONSUMER 5003 no consumer for this content ### TMS\_STATUS\_POSTPONED \#define TMS\_STATUS\_POSTPONED 5023 app can use this to postpone a PUT\_FILE request ### TMS\_STATUS\_REGISTER\_FAIL \#define TMS\_STATUS\_REGISTER\_FAIL 5011 app registration failure ### TMS\_STATUS\_REGISTER\_NAME\_TOO\_LONG \#define TMS\_STATUS\_REGISTER\_NAME\_TOO\_LONG 5012 app registration name too long ### TMS\_STATUS\_REQUESTED \#define TMS\_STATUS\_REQUESTED 5010 app event is available ### TMS\_STATUS\_SERVER\_INSTANCE\_ALREADY\_LOCKED \#define TMS\_STATUS\_SERVER\_INSTANCE\_ALREADY\_LOCKED 5018 server instance already locked ### TMS\_STATUS\_SERVER\_INSTANCE\_CONFIG\_LOAD\_ERROR \#define TMS\_STATUS\_SERVER\_INSTANCE\_CONFIG\_LOAD\_ERROR 5021 error loading server instance config ### TMS\_STATUS\_SERVER\_INSTANCE\_ERROR \#define TMS\_STATUS\_SERVER\_INSTANCE\_ERROR 5015 generic error with server instance ### TMS\_STATUS\_SERVER\_INSTANCE\_LOCK\_ERROR \#define TMS\_STATUS\_SERVER\_INSTANCE\_LOCK\_ERROR 5016 server instance lock error ### TMS\_STATUS\_SERVER\_INSTANCE\_LOCK\_TIMEOUT\_ERROR \#define TMS\_STATUS\_SERVER\_INSTANCE\_LOCK\_TIMEOUT\_ERROR 5017 server instance lock timeout error ### TMS\_STATUS\_SERVER\_INSTANCE\_MAX\_LOCK\_REQ\_EXCEEDED \#define TMS\_STATUS\_SERVER\_INSTANCE\_MAX\_LOCK\_REQ\_EXCEEDED 5019 too many lock requests ### TMS\_STATUS\_SERVER\_INSTANCE\_UNLOCK\_ERROR \#define TMS\_STATUS\_SERVER\_INSTANCE\_UNLOCK\_ERROR 5020 server instance unlock error ### TMS\_STATUS\_STRING\_TOO\_LONG \#define TMS\_STATUS\_STRING\_TOO\_LONG 5032 app description/details string too long ### TMS\_STATUS\_SUCCESS \#define TMS\_STATUS\_SUCCESS 0 successful status ### TMS\_STATUS\_UNSUPPORTED\_FEATURE \#define TMS\_STATUS\_UNSUPPORTED\_FEATURE 5001 unsupported feature ### TMS\_STRING\_LENGTH\_64 \#define TMS\_STRING\_LENGTH\_64 64 ### TypedefDocumentation ### tms\_apptype\_t typedef enum \[\\\_tms\_apptype]\(#afb2687e1bbb997a41d362c43bc78ad1c) \[tms\_apptype\_t]\(#a317e53c1d967d8bf7790a855726aab63) ### tmsEventCallback typedef int(\\\* tmsEventCallback) (struct \[tmsEventData]\(#structtms\_event\_data) eventData) ### tmsEventCallback2 typedef int(\\\* tmsEventCallback2) (struct \[tmsEventData]\(#structtms\_event\_data) \\\*eventData, void \\\*data) ### tmsSetAppParamHashCB typedef int(\\\* tmsSetAppParamHashCB) (char \\\*paramName, char \\\*paramValue, size\_t paramValueLen) ### EnumerationType Documentation ### \_tms\_apptype enum \[\\\_tms\_apptype]\(#afb2687e1bbb997a41d362c43bc78ad1c) | | | | ------------------------------- | - | | Enumerator | | | TMS\_APP\_TYPE\_DEFAULT | | | TMS\_APP\_TYPE\_OS | | | TMS\_APP\_TYPE\_APPLICATION | | | TMS\_APP\_TYPE\_SCRIPT | | | TMS\_APP\_TYPE\_CP\_APPLICATION | | | TMS\_APP\_TYPE\_ADK | | | TMS\_APP\_TYPE\_PAYMENT\_APP | | | TMS\_APP\_TYPE\_AGENT | | | TMS\_APP\_TYPE\_VALUE\_ADD | | | TMS\_APP\_TYPE\_CUSTOM | | ### FunctionDocumentation ### tms\_blgetPOSAgetnInfo() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_blgetPOSAgetnInfo This function is called by the application to request information about POS Agent information. Has processing only under Verix OS file. **Parameters** \[in] **buffer** = pointer to buffer for result \[in] **size** = size of mentioned buffer #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the blocking library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully receive POS Agent information. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback is ignored in this case. ### tms\_callServer() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_callServer This function is used by the application to call the management server. The app does not need to be registered in order to request a TMS call. If the app is registered, it will get status information about the server communication in its callback. **Parameters** \[in] **secondsToWait** = the number of seconds from now to contact the server. This can be used to schedule server contacts for the future. A value of 0 indicates to contact the server right now. #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the contact server request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback status events will only be sent to registered applications. ### tms\_callServer2() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_callServer2 This function is used by the application to call the management server. The app does not need to be registered in order to request a TMS call. If the app is registered, it will get status information about the server communication in its callback. **Parameters** \[in] **secondsToWait** = the number of seconds from now to contact the server. This can be used to schedule server contacts for the future. A value of 0 indicates to contact the server right now. \[in] **iFlags** = coming in through the API is an int while iFlags in the request\_msg structure is only a bool. So once we get more than 8 flags in this API we will need to do handle this #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the contact server request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback status events will only be sent to registered applications. ### tms\_clearApplicationInfo() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_clearApplicationInfo The application can call this function to clear any parameters the app has sent to the agent that the agent has cached. Since the agent will only request application info periodically, this API can be used when the app needs to change a parameter it has already provided to the agent. After calling this API, the agent cached information for the app will be cleared, and the agent will be forced to request the application info the next time it needs it with the TMS\_EVT\_SET\_APP\_INFO event #### Returns int = status of the call. TMS\_STATUS\_REQUESTED indicates the call was successful (but not necessarily the clearing of the cached data). The final result of the call will come in the registered callback handler with TMS\_EVT\_CLEAR\_APP\_INFO\_RESULT. All other values indicate a failure ### tms\_deleteServerInstance() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_deleteServerInstance The application will call this function to remove all content of mentioned server instance **Parameters** \[in] **deleteInstanceId** = the name of the server instance which should be completely removed from device #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the release server lock request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback will provide final status of releasing the lock IMPORTANT NOTES: App has to unlock instance before it can be deleted. Active and Primary instances can't be removed. ### tms\_getAgentVersion() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[version\_t]\(#structversion\_\_t) tms\_getAgentVersion This function is used by an application to get the version of the ADK TMS Agent that is running on the device. #### Returns [version\_t](#structversion__t) structure IMPORTANT NOTES: * This function could return incomplete Maintenance versions * This function will communicate to the ADK TMS Agent via pipes/message queues so it may block for a short period of time ### tms\_GetAgentVersion() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) char\\\* tms\_GetAgentVersion This function is used by an application to get the version of the ADK TMS Agent that is running on the device. #### Returns version string IMPORTANT NOTES: * This function will communicate to the ADK TMS Agent via pipes/message queues so it may block for a short period of time ### tms\_getApplicationFileAvailable() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) int tms\_getApplicationFileAvailable The application will call this function in response to a GET\_FILE event received in its callback. When the agent requests a file with GET\_FILE, the application will put the file in a shared location and use this call to notify the agent that the file is available. **NOTE: the shared location file must have read permissions for the agent. Also, this is currently only used for parameter management.** **Parameters** \[in] **handle** = this should be the same handle provided in the callback event. \[in] **result** = the status of the application getting the file. If the agent requests a file that the application should not share, the app should respond with an error. TMS\_STATUS\_SUCCESS indicates getting the file was successful, any other value indicates an error \[in] **fileLocation** = the shared location where the application put the requested file. This only needs to be set if the file retrieval was successful. \[in] **removeFile** = a boolean telling the agent whether it should delete the file when it is finished with it. For cases where the app copies a file from its private area to a shared area, this should be set to TRUE. #### Returns int = status of the call. TMS\_STATUS\_SUCCESS indicates the call was successful. All other values indicate a failure. IMPORTANT NOTES: This is used by the application to respond to TMS\_EVT\_GET\_FILE request from the agent ### tms\_getConfigLocation() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_getConfigLocation This function is called by the application to request the location of the VHQ configuration file. #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the contact server request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback status events will only be sent to registered applications. ### tms\_getServerInstance() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_getServerInstance The application will call this function to get the name of the current server instance being used #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the get server instance request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback will provide further status including the name of the current server instance. ### tms\_getUpdates() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_getUpdates This function is used by the application to request updates from the management server. The app needs to be registered in order to request a TMS call. The app will get status information about the downloads and it's notifications in its callback. **Parameters** \[in] **updateType** = specified \[in] **software** = reference set name or parent reference set name \[in] **reference** = self or parent #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the update request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback status events will only be sent to registered applications. ### tms\_getVersion() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[version\_t]\(#structversion\_\_t) tms\_getVersion This function is used by an application to get the version of TMS library that the application is linked with, or the shared version of the library that the application is using. #### Returns [version\_t](#structversion__t) structure IMPORTANT NOTES: This function could return incomplete Maintenance versions ### tms\_GetVersion() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) char\\\* tms\_GetVersion This function is used by an application application to get the version of TMS library that the application is linked with, or the shared version of the library that the application is using. #### Returns version string ### tms\_idsMode() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) bool tms\_idsMode Called by application to find if device is in IDS mode or not **Parameters** \[out] **TRUE/FALSE** - IDS mode is TRUE/FALSE ### tms\_lockServerInstance() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_lockServerInstance The application will call this function to lock the server instance to the provided instanceId. A timeout can be provided and if the lock can't be obtained in the time period specified, the call will fail. **Parameters** \[in] **instanceId** = the name of the server instance to set the agent to if the lock is obtained successfully \[in] **mlSecTimeout** = number of milliseconds to wait for the lock. If the lock can't be obtained in the time specified, an error will be returned. A value of 0 for this means to wait forever. #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the lock server instance request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback will provide further status including the status of the lock and the name of the current instanceID. IMPORTANT NOTES: The current instanceID being used will be returned in the callback. That name can be used in the [tms\_releaseServerLock()](#ad6387ab34756d72bb79c20682d8a0366) call to restore the instance that was in use before the app requested the lock on the new server ### tms\_registerApplication() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_registerApplication This function is used by the application to register itself with the VHQ agent. When registering, the application provides its name, a mask specifying the types of events the application would like to be notified of, and a callback function for handling events sent to the app from the VHQ agent. **Parameters** \[in] **appName** = A name used by the VHQ agent to help identify the different applications that are registered. The app name is used for identification purposes, as well as parameter management.The registered app name MUST match the application name specified in Secure Installer bundle for V/OS devices, or the application name specified in Manifest files for VX devices. This name is case sensitive so it must match exactly. \[in] **eventNotifyMask** = A mask provided by the application to configure the events that the application wants to be notified of by the VHQ agent. The application can request notification for these types of events:o Reboot (0x00000001) = Notify the application before the agent performs a reboot. If registered for this notification, the application will have to approve a reboot which will give the app time to perform any required tasks before the reboot occurs.o Restart Applications (0x00000002) = Notify the application before the agent performs a restart of all applications. If registered for this notification, the application will have to approve the application restart which will give the app time to perform any required tasks before the application restarts.o Download Started (0x00000004) = Notify the application when the agent begins a download.o Download Percent (0x00000008) = Notify the application with updates about the progress of an ongoing download (this is not available in the current version of the VHQ Agent but will be added in future versions).o Download Completed (0x00000010) = Notify the application when the agent completes a download.o Install Download (0x00000020) = Notify the application before a download is installed by the agent. If registered for this notification, the application will have to approve the install which will give the app time to perform any required tasks before the device is possibly restarted as part of the installation.o Maintenance End (0x00000040) = Notify the application when all maintenance activities for a given heartbeat have been completed.o Heartbeat Result (0x00000080) = Notify the application with the final result of heartbeat messages to the servero Contact Server Start (0x00000100) = Notify the application when contact to the server is beginning.o Contact Server End (0x00000200) = Notify the application when all contact to the server for a given session has completed.o Contact Server Approval (0x00000400) = When registered for this notification, the application will have to approve the agent contacting the server. This is useful for dial-up connections so that the agent will not try to use the modem while the application is using it.o Application Content Update Available (0x00000800) = Notify the application when content is available for the application. This notification must be enabled for the application to support VHQ content management.o Clock Update (0x00001000) = Notify the application before the agent performs a clock update. If registered for this notification, the application will have to approve the clock update so the app can adjust any timers, etc.o Server Errors (0x00002000) = Notify the application when a communication with the server fails, including an error code.o Processing Status (0x00008000) = Notify the application with processing.ini file, this provides device, message and server status after an operation.o Download Retry (0x00010000) = Notify the application with the retry count of downloads.o Network Error (0x00020000) = Notify the application if there are any network errors.o Download Count (0x00040000) - Notify the application with the number of downloads in a MPo Get Software Update (0x00080000) - Notify the application if MMS Get Software Update is successful. \[in] **tmsEvtCb** = A callback function provided by the application to handle events sent from the agent to the application. The prototype for the callback function is: int tmsEventCallback(struct tmsEventData eventData); The following events can be sent from the agent to the application and need to be handled by the application in the callback:All registered applications must handle these eventso SET\_APP\_INFO (eventData.evtType = 7) = event used by the agent to request application specific parameters to be sent up in VHQ messages to the VHQ server. The application should call tms\_setApplicationInfo() in response to this message. DeviceId would be an example of a parameter passed from the application to the agento SET\_PARM\_LIST (eventData.evtType = 8) = event used by the agent to request a list of application files that can be managed through VHQ. The application should call tms\_setApplicationParameterList() in response to this message. The list of files provided is mainly used for parameter management but can be used for more than that. At a minimum, the app should call tms\_setApplicationParameterList() with numParamFiles=0 and paramInfoFile=NULLIf the app registers with any of these notification flags set in its register call(TMS\_EVENT\_NOTIFY\_REBOOT\_DEVICE, TMS\_EVENT\_NOTIFY\_RESTART\_APPS, TMS\_EVENT\_NOTIFY\_INSTALL\_DOWNLOAD, TMS\_EVENT\_NOTIFY\_CONTACT\_SERVER\_APPROVAL or TMS\_EVENT\_NOTIFY\_CLOCK\_UPDATE), then it needs to handle this event:o SET\_APP\_STATE (eventData.evtType = 6) = event used by the agent to request the application state (whether it is busy or free). The application should call tms\_setApplicationState() in response to this message.If content management, parameter management, or being able to upload app files to the server is desired, then these events should be handled:o GET\_FILE (eventData.evtType = 9) = event used by the agent to retrieve a file from the application. This event is used for parameter management. The application should call tms\_getApplicationFileAvailable() with the shared location of the parameter file in response to this message.o PUT\_FILE (eventData.evtType = 10) = event used by the agent to send a file to the application. This event is used for parameter management and content management. The application should call tms\_setFileOperationResult() in response to this message.o DEL\_FILE (eventData.evtType = 11) = event used by the agent to request the application to delete one of its files. The application should call tms\_setFileOperationResult() in response to this message. It is up to the application as to whether it will actually delete the file. For instance, the app should respond with an error if the DEL\_FILE event is trying to delete a file that should not be deleted.o DO\_TRANSACTION (eventData.evtType = 12) = event used by the agent to request the application to do a transaction (such as a daily clearance or diagnostics). The application should call tms\_setTransactionResult() in response to this message.These events can be handled by the application if it wants to keep up to date with the status of the TMS Agent, and what it is doing. No response is required from the app for these eventso REGISTER\_APP\_RESPONSE (eventData.evtType = 1) = event to provide the result of the tms\_registerApplication() request.o UNREGISTER\_APP\_RESPONSE (eventData.evtType = 2) = event to provide the result of the tms\_unregisterApplication() request. This event will only get sent if the unregister call fails.o CALL\_SERVER\_RESPONSE (eventData.evtType = 3) = event to provide the result of a tms\_callServer() request.o GET\_TMS\_CONFIG\_RESPONSE (eventData.evtType = 4) = event to provide the result of a tms\_getConfigLocation() request.o SET\_TMS\_CONFIG\_RESPONSE (eventData.evtType = 5) = event to provide the result of a tms\_setNewConfigAvailable() request.o EVENT\_NOTIFICATION (eventData.evtType = 13) = event sent by the agent to notify the application of the different events the app requested notificaction for in its register call.\*NOTE: For the events that the agent expects a response from, the agent will timeout after 30 seconds of waiting for the response. The events that the agent expects a response from are: SET\_APP\_INFO, SET\_PARM\_LIST, GET\_FILE, PUT\_FILE, DEL\_FILE and DO\_TRANSACTION. So if the application is not calling response APIs directly in the callback, it must call the response API within 30 seconds of receiving the event in the callback. SET\_APP\_STATE expects a response as well but the agent will wait 5 minutes for the application to respond to a SET\_APP\_STATE event.\*NOTE2: The 30 second timeout and 5 minute timeout are default timeout values. These are configurable via the "AppIfc Event Response Timeout" and "AppIfc SetAppState Timeout" VHQ parameters (respectively). #### Returns struct [tmsReturn](#structtms_return) - a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the register request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback IMPORTANT NOTES: * The service will identify the caller of the registration function so no indentification parameters are necessary ### tms\_registerApplication2() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_registerApplication2 ### tms\_registerApplication3() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_registerApplication3 ### tms\_releaseServerLock() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_releaseServerLock The application will call this function to release a lock it has obtained on server instances **Parameters** \[in] **restoreInstanceId** = the name of the server instance to restore when the lock is released (obtained in the callback response to tms\_lockServerInstance() call) #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the release server lock request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback will provide final status of releasing the lock IMPORTANT NOTES: If the app wants to restore the previous instance, it can pass the instanceID that was returned from the lock call to this API. The agent will restore the previous instance after the unlock request is processed. ### tms\_sendApplicationAlert() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_sendApplicationAlert The application can call this function to generate an application based alert on the server **Parameters** \[in] **description** = A short description of the alert (MAX 256 characters) \[in] **severity** = The severity of the alert (valid values are TMS\_ALERT\_SEVERITY\_LOW, TMS\_ALERT\_SEVERITY\_MEDIUM or TMS\_ALERT\_SEVERITY\_HIGH) \[in] **details** = Optional string to provide details about the alert to the server (MAX 511 characters) #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the alert request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback will provide further status including the status of sending the alert to the server ### tms\_sendCustomAppEvent() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_sendCustomAppEvent The application can call this function to generate an application based custom event on the server **Parameters** \[in] **appName** = Application Name \[in] **description** = A short description of the event (MAX 256 characters) \[in] **details** = Optional string to provide details about the event to the server (MAX 256 characters) #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the alert request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback will provide further status including the status of sending the event to the server ### tms\_sendCustomAppEvent2() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_sendCustomAppEvent2 The application can call this function to generate an application based custom event on the server **Parameters** \[in] **tmsCustomAppEventStruct** = Structure to pass the event information appName (Application Name (MAX 32 characters)) eventName (The event name detected by Server (MAX 64 characters)) additional\_info (string to provide details about the event to the server (MAX 256 characters)) #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the alert request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback will provide further status including the status of sending the event to the server ### tms\_sendParameterUpdate() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_sendParameterUpdate ### tms\_sendParameterUpdateCallback() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) int tms\_sendParameterUpdateCallback ### tms\_setApplicationInfo() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) int tms\_setApplicationInfo The application will call this function in response to a SET\_APP\_INFO event received in its callback. This will allow the application to send application specific parameters to the agent that can be sent in VHQ messages to the server. There are three types of parameters that the application can send to the agent: IDENTIFIER, DEVICE\_PROFILE and DIAGNOSTIC parameters. The eventMask field of the event will contain the mask of the parameters the agent is requesting. The application should provide only the type of parameters requested by the agent in the eventMask field. One example of this would be the Device ID that is controlled by the application. Another example would be the Lane/Store info that is controlled by the POS system , but can be retrieved by the application. **Parameters** \[in] **handle** = this should be the same handle provided in the callback event. \[in] **appInfo** = a structure containing all of the application specific parameters that can be sent to the VHQ server. There are 3 types of parameters that can be sent to the server: TMS\_PARAMETER\_TYPE\_IDENTIFIER = IDENTIFIER parameters are included in every message that the agent sends to the server. Examples include "DeviceId" or "StoreId". TMS\_PARAMETER\_TYPE\_DEVICE\_PROFILE = DEVICE\_PROFILE parameters are not currently sent to the server TMS\_PARAMETER\_TYPE\_DIAGNOSTIC = DIAGNOSTIC parameters are sent to the server in response to a special GetDiagData request made by the server. The server currently makes the special GetDiagData request once per day. Examples would be statistics collected by the application. #### Returns int = status of the call. TMS\_STATUS\_SUCCESS indicates the call was successful. All other values indicate a failure. IMPORTANT NOTES: This is used by the application to respond to TMS\_EVT\_SET\_APP\_INFO request from the agent. ### tms\_setApplicationParameterHash() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) int tms\_setApplicationParameterHash ### tms\_setApplicationParameterList() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) int tms\_setApplicationParameterList The application will call this function in response to a SET\_PARM\_LIST event received in its callback. The application can provide a filename that contains a list of parameter files that can be managed through VHQ in its response. **Parameters** \[in] **handle** = this should be the same handle provided in the callback event. \[in] **numParamFiles** = the number of parameter files described in paramInfoFile. \[in] **paramInfoFile** = a file that lists all of the applications parameter files, as well as a hash value for each of the parameter files. this file will contain a line for each paramter file each line will have 3 whitespace separated fields - Name, Hash Algo, Hash i.e. "TMS.ini SHA1 0ad19e6f4424a459b625fb38de402226b012e8d7" #### Returns int = status of the call. TMS\_STATUS\_SUCCESS indicates the call was successful. All other values indicate a failure. IMPORTANT NOTES: This is used by the application to respond to TMS\_EVT\_SET\_PARM\_LIST request from the agent ### tms\_setApplicationState() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) int tms\_setApplicationState The application will call this function in response to a SET\_APP\_STATE event received in its callback. If the application is not busy, it will respond with a FREE status. If the application is busy, it can respond with a BUSY status which will prevent certain agent operations (like a reboot) from taking place. After the application completes what is causing it to respond with BUSY, it will call this function again with the FREE status. The application will have 5 minutes to respond with the FREE status after responding with the BUSY status. If the application does not respond with a FREE status within 5 minutes of responding with BUSY status, the agent will continue with its planned operation. This function can also be called at any time by the app to set its BUSY or FREE state. This will allow the app to pre-emtively cause certain operations (like reboot) from occurring. So if the app sets its state to BUSY without a SET\_APP\_STATE event being received in the callback, the agent will already know the app is BUSY and wont send the SET\_APP\_STATE in situations when it normally would (like just before rebooting the terminal). Instead the agent will wait for the app to set its state to FREE before proceeding. For instance, before the app does its daily clearance, it can pre-emtively use this function to set its state to BUSY. When the app is complete with the daily clearance, it can the use this function to set its state to FREE again. NOTE: The 5 minute timeout to set FREE status is the default value, but is configurable in the "AppIfc Busy Response Timeout" VHQ parameter. **Parameters** \[in] **handle** = this should be the same handle provided in the callback event. If using this function pre-emtively, the handle should be set to -1. \[in] **appState** = the state of the app. APP\_STATUS\_FREE if the application is free, or APP\_STATUS\_BUSY if the application is busy. #### Returns int - status of the call. TMS\_STATUS\_REQUESTED indicates the call was successful. All other values indicate a failure. ### tms\_setFileOperationResult() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) int tms\_setFileOperationResult The application will call this function in response to a PUT\_FILE or DEL\_FILE event received in its callback. When the agent requests a PUT\_FILE, the application should copy the file from the location provided by the event, into its own directory (if allowed). When the agent requests a DEL\_FILE, the application should delete the specified file (if allowed). If the PUT\_FILE or DEL\_FILE is trying to operate on a file that should not be operated on, then the app should respond with an error. **Parameters** \[in] **handle** = this should be the same handle provided in the callback event. \[in] **fileOpResult** = the status of the PUT\_FILE or DEL\_FILE request. TMS\_STATUS\_SUCCESS should be used to indicate the operation was successful. Any other status response indicates to the agent that the file operation failed. \[in] **fileOpType** = this should be the same event type provided in the callback event. For PUT\_FILE requests, it should be PUT\_FILE and for DEL\_FILE requests it should be DEL\_FILE. #### Returns int = status of the call. TMS\_STATUS\_SUCCESS indicates the call was successful. All other values indicate a failure. IMPORTANT NOTES: This is used by the application to respond to TMS\_EVT\_PUT\_FILE or TMS\_EVT\_DEL\_FILE request from the agent ### tms\_setFileOperationResultWithDescription() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) int tms\_setFileOperationResultWithDescription The application will call this function in response with description to a PUT\_FILE or DEL\_FILE event received in its callback. When the agent requests a PUT\_FILE, the application should copy the file from the location provided by the event, into its own directory (if allowed). When the agent requests a DEL\_FILE, the application should delete the specified file (if allowed). If the PUT\_FILE or DEL\_FILE is trying to operate on a file that should not be operated on, then the app should respond with an error. **Parameters** \[in] **handle** = this should be the same handle provided in the callback event. \[in] **fileOpResult** = the status of the PUT\_FILE or DEL\_FILE request. TMS\_STATUS\_SUCCESS should be used to indicate the operation was successful. Any other status response indicates to the agent that the file operation failed. \[in] **fileOpType** = this should be the same event type provided in the callback event. For PUT\_FILE requests, it should be PUT\_FILE and for DEL\_FILE requests it should be DEL\_FILE. \[in] **additional\_info** = this is a string, mostly used for error cases, that can be relayed to the server with the result. Maximum length of this string should be 256 characters. #### Returns int = status of the call. TMS\_STATUS\_SUCCESS indicates the call was successful. All other values indicate a failure. IMPORTANT NOTES: This is used by the application to respond to TMS\_EVT\_PUT\_FILE or TMS\_EVT\_DEL\_FILE request from the agent ### tms\_setNewConfigAvailable() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_setNewConfigAvailable This function can be used by the application to tell the VHQ agent to load and run with a new configuration. When using this function, the application should first call the [tms\_getConfigLocation()](#a3889f0d3c64ccf4c76d02c75f0a317b1) function to get the location of the current VHQ configuration. The application should then make a temporary copy of the current VHQ configuration and edit the temporary copy for any configuration updates the application wants to make. After making the changes to the temporary file, the [tms\_setNewConfigAvailable()](#a3d8613b634236bc3919b51bd2a012beb) function should be called and the temporary file with the requested changes should be passed to this function. The agent will load the new changes and store them in its permanent configuration. The configuration changes will occur in run-time and no reboot is required. The App does not need to be registered in order to request a TMS config update **Parameters** \[in] **newTMSConfig** = the full path to the new TMS configuration file.NOTE: The agent must have read permissions on the temporary file for this to work correctly. #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the contact server request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback status events will only be sent to registered applications. ### tms\_setNewConfigAvailableWithTimeout() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_setNewConfigAvailableWithTimeout This function can be used by the application to tell the VHQ agent to load and run with a new configuration. When using this function, the application should first call the [tms\_getConfigLocation()](#a3889f0d3c64ccf4c76d02c75f0a317b1) function to get the location of the current VHQ configuration. The application should then make a temporary copy of the current VHQ configuration and edit the temporary copy for any configuration updates the application wants to make. After making the changes to the temporary file, the [tms\_setNewConfigAvailable()](#a3d8613b634236bc3919b51bd2a012beb) function should be called and the temporary file with the requested changes should be passed to this function. The agent will load the new changes and store them in its permanent configuration. The configuration changes will occur in run-time and no reboot is required. The App does not need to be registered in order to request a TMS config update **Parameters** \[in] **newTMSConfig** = the full path to the new TMS configuration file.NOTE: The agent must have read permissions on the temporary file for this to work correctly. \[in] **timeout** = time to wait (in seconds) before giving up because the agent might be busy.NOTE: This parameter only applies to tms\_setNewConfigAvailableWithTimeout API. #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the contact server request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback status events will only be sent to registered applications. ### tms\_setTransactionResult() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) int tms\_setTransactionResult The application will call this function in response to a DO\_TRANSACTION event received in its callback function. The application will report the result of the requested transaction in this function call. **Parameters** \[in] **handle** = this should be the same handle provided in the callback event. \[in] **transactionResult** = the status of the DO\_TRANSACTION request. TMS\_STATUS\_SUCCESS should be used to indicate the transaction was successful. Any other status response indicates to the agent that the transaction failed. #### Returns int = status of the call. TMS\_STATUS\_SUCCESS indicates the call was successful. All other values indicate a failure. IMPORTANT NOTES: This is used by the application to respond to TMS\_EVT\_DO\_TRANSACTION request from the agent ### tms\_unregisterApplication() \[TMS\_API]\(#aed564c0d7f8be3217e05a223cac4921e) struct \[tmsReturn]\(#structtms\_return) tms\_unregisterApplication This function is used by an application to unregister itself with the TMS Agent **Parameters** \[in] **appName** = The name the app provided in its registration call. #### Returns struct [tmsReturn](#structtms_return) = a [tmsReturn](#structtms_return) structure [tmsReturn.status](#a6e27f49150e9a14580fb313cc2777e00) = the immediate library status response. TMS\_STATUS\_REQUESTED indicates the library was able to successfully send the unregister request to the VHQ Agent. All other return values indicate a failure. [tmsReturn.handle](#a3127ebf018e9da62fa464d348352037d) = the handle used for further status tracking in the callback. The callback will only get status messages with this handle only in the case where the unregistration fails. Upon successful unregistration, the only response the application will get is TMS\_STATUS\_REQUESTED status in response to this call. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://sandbox-docs.verifone.com/s-adk-5.1-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_a00d4a910169eda6e4cf562ea5c727be/svc__tms_8h.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.