Prosody X: API: sm_open_prosody_x

Prototype Definition

int sm_open_prosody_x(struct sm_open_prosody_x_parms *openp)

Parameters

*openp

a structure of the following type:

typedef struct sm_open_prosody_x_parms {
	char *px_locator;					/* in */
	tSMCardId card_id;					/* in */
} SM_OPEN_PROSODY_X_PARMS;

Description

Opens a Prosody X card for use with the Prosody API. This function must be invoked by applications using the V6 interface to register the tSMCardId value for passing into any other Prosody API function which refers to this card.

The security key in the px_locator is only validated when establishing a connection with a module on the card. Supplying a incorrect key will result in an error return from a function call some time after sm_open_module() has reported success, as the connection is made asynchronously.

Note: Almost all uses of a Prosody X card require the datafeed firmware module to be downloaded.

An open card can be closed by calling sm_close_prosody().

Fields

px_locator

The IP address used by the ProsodyX card, or its registered name (i.e. a valid input to the standard function getaddrinfo()). If the card is using a security key, the IP address is followed by a slash (/) character and the security key.

Note that IPv6 addresses in numeric form should be enclosed in square brackets, for example "[2010:836B:4179::836B:4179]/mykey".

card_id

An arbitrary value representing the open card.

Returns

0 if call completed successfully, otherwise a standard error.

This function is part of the Prosody X API.