DevKit System Initialization (lkt_devkit_init)

dvkerr_t  lkt_devkit_init( void );

Before calling any other functions, all DevKit applications must:

Make any desired changes to DevKit parameters, by calling lkt_devkit_get_parameters and lkt_devkit_set_parameters.
Call lkt_devkit_init.

This applies to the input-building functions discussed in Input and Output Parameter Types as well as other command functions.

dvk_params_t lkt_get_devkit_parameters( void )

Obtains the current DevKit global settings.

Output

A structure containing the current devkit settings.

Note: The returned trusted_store pointer can be changed, but the memory pointed to by the returned trusted_store member should not be modified.

 

int lkt_set_devkit_parameters( const dvk_params_t* params )

Sets the DevKit global parameters.

This function must only be called before lkt_devkit_init. Calling it after lkt_devkit_init might produce unpredictable results.

Input

The new global parameters for DevKit.

Output

0: Success

Non-zero: error (invalid parameter).

dvkerr_t lkt_devkit_init( void );

Initializes DevKit.

Error codes

This command never returns an error. If it cannot initialize devkit it terminates the process.

dvk_params_t

This structure holds settings that affect DevKit behavior globally. It contains the following members:

int connect_protocols

Controls which protocols DevKit uses to connect to servers. It must be one of

DVK_PROTO_DEFAULT: Use the default setting

DVK_PROTO_IPV4: Use only IPv4

DVK_PROTO_IPV6: Use only IPv6

DVK_PROTO_MIXED: Use either. Actual usage is determined by the system network configuration.

Default: DVK_PROTO_DEFAULT

 

int persist_connections

Controls whether outgoing connections are persistent.

0: outgoing connections are not persistent

non-0: outgoing connections are persistent

Default: 1.

 

int ssl_enabled

Controls if SSL/TLS is used to encrypt data on outgoing connections.

0: data on outgoing connections is plaintext.

non-0: data on outgoing connections is encrypted.

Default: 0

 

const char *trusted_store

Specifies the store of trusted certificates for SSL connections.

For details, see the "--trusted-store command line option" in the TIBCO® Patterns Installation Guide.