Tizen Native API  5.5
Functions | Typedefs
SoftAP Client
SoftAP

SoftAP Client API provides functions to get the information about a connected client.

Required Header

#include <softap.h>

Overview

This set of functions is used to get information about a connected client.

Related Features

This API is related with the following features:

  • http://tizen.org/feature/network.wifi.softap

It is recommended to design applications with regard to features, for reliability.

You can check if a device supports the related features for this API by using System Information, and control your application's actions accordingly.

To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.

More details on featuring your application can be found from Feature Element.

Functions

int softap_client_clone (softap_client_h *dest, softap_client_h origin)
 Clones the handle of a client.
int softap_client_destroy (softap_client_h client)
 Destroys the handle of a client.
int softap_client_get_name (softap_client_h client, char **name)
 Gets the name of a client.
int softap_client_get_ip_address (softap_client_h client, softap_address_family_e address_family, char **ip_address)
 Gets the IP address of a client.
int softap_client_get_mac_address (softap_client_h client, char **mac_address)
 Gets the MAC address of a client.
int softap_client_get_time (softap_client_h client, time_t *timestamp)
 Gets the connection time of a client.

Typedefs

typedef void * softap_client_h
 The SoftAP client handle.

Typedef Documentation

typedef void* softap_client_h

The SoftAP client handle.

Since :
5.0

Enumeration Type Documentation

enum softap_address_family_e

Enumeration for address family.

Since :
5.0
Enumerator:
SOFTAP_ADDRESS_FAMILY_IPV4 

IPv4 Address type

SOFTAP_ADDRESS_FAMILY_IPV6 

IPv6 Address type

Function Documentation

int softap_client_clone ( softap_client_h *  dest,
softap_client_h  origin 
)

Clones the handle of a client.

Since :
5.0
Privilege Level:
public
Privilege:
http://tizen.org/privilege/softap
Remarks:
The dest should be released using softap_client_destroy().
Parameters:
[out]destThe cloned client handle
[in]originThe origin client handle
Returns:
0 on success, otherwise a negative error value
Return values:
SOFTAP_ERROR_NONESuccessful
SOFTAP_ERROR_INVALID_PARAMETERInvalid parameter
SOFTAP_ERROR_OUT_OF_MEMORYOut of memory
SOFTAP_ERROR_NOT_SUPPORTEDAPI is not supported
SOFTAP_ERROR_PERMISSION_DENIEDPermission denied
See also:
softap_client_destroy()
int softap_client_destroy ( softap_client_h  client)

Destroys the handle of a client.

Since :
5.0
Privilege Level:
public
Privilege:
http://tizen.org/privilege/softap
Parameters:
[in]clientThe client handle
Returns:
0 on success, otherwise a negative error value
Return values:
SOFTAP_ERROR_NONESuccessful
SOFTAP_ERROR_INVALID_PARAMETERInvalid parameter
SOFTAP_ERROR_NOT_SUPPORTEDAPI is not supported
SOFTAP_ERROR_PERMISSION_DENIEDPermission denied
See also:
softap_client_clone()
int softap_client_get_ip_address ( softap_client_h  client,
softap_address_family_e  address_family,
char **  ip_address 
)

Gets the IP address of a client.

Since :
5.0
Privilege Level:
public
Privilege:
http://tizen.org/privilege/softap
Remarks:
The ip_address should be released using free().
Parameters:
[in]clientThe client handle
[in]address_familyThe address family of IP address. Currently, SOFTAP_ADDRESS_FAMILY_IPV4 is only supported
[out]ip_addressThe IP address
Returns:
0 on success, otherwise a negative error value
Return values:
SOFTAP_ERROR_NONESuccessful
SOFTAP_ERROR_INVALID_PARAMETERInvalid parameter
SOFTAP_ERROR_OUT_OF_MEMORYOut of memory
SOFTAP_ERROR_NOT_SUPPORTEDAPI is not supported
SOFTAP_ERROR_PERMISSION_DENIEDPermission denied
See also:
softap_client_connection_state_changed_cb()
int softap_client_get_mac_address ( softap_client_h  client,
char **  mac_address 
)

Gets the MAC address of a client.

Since :
5.0
Privilege Level:
public
Privilege:
http://tizen.org/privilege/softap
Remarks:
The mac_address should be released using free().
Parameters:
[in]clientThe client handle
[out]mac_addressThe MAC address
Returns:
0 on success, otherwise a negative error value
Return values:
SOFTAP_ERROR_NONESuccessful
SOFTAP_ERROR_INVALID_PARAMETERInvalid parameter
SOFTAP_ERROR_OUT_OF_MEMORYOut of memory
SOFTAP_ERROR_NOT_SUPPORTEDAPI is not supported
SOFTAP_ERROR_PERMISSION_DENIEDPermission denied
See also:
softap_client_connection_state_changed_cb()
int softap_client_get_name ( softap_client_h  client,
char **  name 
)

Gets the name of a client.

Since :
5.0
Privilege Level:
public
Privilege:
http://tizen.org/privilege/softap
Remarks:
The name should be released using free().
Parameters:
[in]clientThe client handle
[out]nameThe name of the client
Returns:
0 on success, otherwise a negative error value
Return values:
SOFTAP_ERROR_NONESuccessful
SOFTAP_ERROR_INVALID_PARAMETERInvalid parameter
SOFTAP_ERROR_OUT_OF_MEMORYOut of memory
SOFTAP_ERROR_NOT_SUPPORTEDAPI is not supported
SOFTAP_ERROR_PERMISSION_DENIEDPermission denied
See also:
softap_client_connection_state_changed_cb()
int softap_client_get_time ( softap_client_h  client,
time_t *  timestamp 
)

Gets the connection time of a client.

Since :
5.0
Privilege Level:
public
Privilege:
http://tizen.org/privilege/softap
Parameters:
[in]clientThe client handle
[out]timestampThe connected time of the client
Returns:
0 on success, otherwise a negative error value
Return values:
SOFTAP_ERROR_NONESuccessful
SOFTAP_ERROR_INVALID_PARAMETERInvalid parameter
SOFTAP_ERROR_NOT_SUPPORTEDAPI is not supported
SOFTAP_ERROR_PERMISSION_DENIEDPermission denied
See also:
softap_client_connection_state_changed_cb()