libtiepie-hw  1.2.5
Servers
Collaboration diagram for Servers:

Modules

 Callbacks
 Functions to set callbacks that are triggered when the server list is changed.
 

Functions

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_network_servers_add (const char *url, uint32_t length, tiepie_hw_handle *handle)
 Add a server to the list of servers. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_network_servers_remove (const char *url, uint32_t length, tiepie_hw_bool force)
 Remove a server from the list of servers. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_network_servers_get_count (void)
 Get the number of servers available. More...
 
TIEPIE_HW_API tiepie_hw_handle tiepie_hw_network_servers_get_by_index (uint32_t index)
 Get the handle of a server, based on its index in the list of servers. More...
 
TIEPIE_HW_API tiepie_hw_handle tiepie_hw_network_servers_get_by_url (const char *url, uint32_t length)
 Get the handle of a server, based on its URL. More...
 

Detailed Description

Function Documentation

◆ tiepie_hw_network_servers_add()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_network_servers_add ( const char *  url,
uint32_t  length,
tiepie_hw_handle handle 
)

Add a server to the list of servers.

Parameters
[in]urlPointer to URL character buffer.
[in]lengthLength of URL buffer or TIEPIE_HW_STRING_LENGTH_NULL_TERMINATED.
[out]handleThe handle to the added server or NULL.
Returns
TIEPIE_HW_BOOL_TRUE if added successfully, TIEPIE_HW_BOOL_FALSE otherwise.
Since
1.0

◆ tiepie_hw_network_servers_remove()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_network_servers_remove ( const char *  url,
uint32_t  length,
tiepie_hw_bool  force 
)

Remove a server from the list of servers.

Parameters
[in]urlPointer to URL character buffer.
[in]lengthLength of URL buffer or TIEPIE_HW_STRING_LENGTH_NULL_TERMINATED.
[in]forceIf TIEPIE_HW_BOOL_TRUE all open devices are closed, if TIEPIE_HW_BOOL_FALSE remove only succeeds if no devices are open.
Returns
TIEPIE_HW_BOOL_TRUE if removed successfully, TIEPIE_HW_BOOL_FALSE otherwise.
Since
1.0

◆ tiepie_hw_network_servers_get_count()

TIEPIE_HW_API uint32_t tiepie_hw_network_servers_get_count ( void  )

Get the number of servers available.

Returns
The number of servers available.
Since
1.0

◆ tiepie_hw_network_servers_get_by_index()

TIEPIE_HW_API tiepie_hw_handle tiepie_hw_network_servers_get_by_index ( uint32_t  index)

Get the handle of a server, based on its index in the list of servers.

Parameters
[in]indexA server index, 0 .. tiepie_hw_network_servers_get_count() - 1.
Returns
The handle to the requested server or NULL.
Since
1.0

◆ tiepie_hw_network_servers_get_by_url()

TIEPIE_HW_API tiepie_hw_handle tiepie_hw_network_servers_get_by_url ( const char *  url,
uint32_t  length 
)

Get the handle of a server, based on its URL.

Parameters
[in]urlPointer to URL character buffer.
[in]lengthLength of URL buffer or TIEPIE_HW_STRING_LENGTH_NULL_TERMINATED.
Returns
The handle to the requested server or NULL.
Since
1.0