*
* @return The MAC address in the form '00-00-00-00-00-00'
* @remarks In case of the Wi-Fi Direct bearer type, the MAC address is virtual and is used only for the frame packetization. @n
- * This MAC address is different from the MAC address provided by the WifiManager or the WifiDirectDevice class.
+ * This MAC address is different from the MAC address provided by the Wifi::WifiManager or the Wifi::WifiDirectDevice class.
*/
Tizen::Base::String GetMacAddress(void) const;
class _HttpMessageImpl;
/**
* @class HttpMessage
- * @brief This class is the base class for HttpRequest and HttpResponse.
+ * @brief This class is the base class for %HttpRequest and %HttpResponse.
*
* @since 2.0
*
* @exception E_TIMEOUT An attempt to connect to the server has timed out.
* @exception E_NOT_RESPONDING There is no response.
* @exception E_DNS_NOT_FOUND The DNS lookup has failed.
- * @remarks Always check the error code before accessing the result.
- * If @c r is not E_SUCCESS, @c ipHostEntry may not exist.
+ * @remarks Always check the error code before accessing the result. @n
+ * If @c r is not @c E_SUCCESS, @c ipHostEntry may not exist.
*/
virtual void OnDnsResolutionCompletedN(IpHostEntry* pIpHostEntry, result r) = 0;
}; // IDnsEventListener
* @return An error code
* @param[in] localAddrScheme An indicator specifying whether to use a static local IP address
* @param[in] pLocalAddress The local IP address @n
- * If @c localAddrScheme is set to NET_ADDRESS_SCHEME_STATIC, the local IP address assigned is static.
- * If @c localAddrScheme is set to NET_ADDRESS_SCHEME_DYNAMIC or NET_ADDRESS_SCHEME_NONE, this parameter is ignored.
+ * If @c localAddrScheme is set to @c NET_ADDRESS_SCHEME_STATIC, the local IP address assigned is static.
+ * If @c localAddrScheme is set to @c NET_ADDRESS_SCHEME_DYNAMIC or @c NET_ADDRESS_SCHEME_NONE, this parameter is ignored.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @see GetLocalAddress()
* else @c null if an error occurs or the dynamic address scheme is being used
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION This operation is not allowed in the dynamic address scheme.
- * @remarks When this instance is got by NetAccountManager::GetNetAccountInfoN(),
+ * @remarks
+ * - When this instance is got by NetAccountManager::GetNetAccountInfoN(),
* - this method returns a statically assigned primary DNS address pointer if the DNS address scheme is NET_ADDRESS_SCHEME_STATIC
* - this method returns @n null if the DNS address scheme is @c NET_ADDRESS_SCHEME_DYNAMIC @n
- * The specific error code can be accessed using the GetLastResult() method.
- * @see GetSecondaryDnsAddress()
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * @see GetSecondaryDnsAddress()
*/
const IpAddress* GetPrimaryDnsAddress(void) const;
/**
* Enables or disables the use of a static DNS address with the specified IpAddress objects. @n
- * If @c dnsAddrScheme is NET_ADDRESS_SCHEME_DYNAMIC, both @c primaryDnsAddress and @c secondaryDnsAddress are ignored. @n
- * If @c dnsAddrScheme is NET_ADDRESS_SCHEME_STATIC, @c primaryDnsAddress must be a valid IpAddress.
+ * If @c dnsAddrScheme is @c NET_ADDRESS_SCHEME_DYNAMIC, both @c primaryDnsAddress and @c secondaryDnsAddress are ignored. @n
+ * If @c dnsAddrScheme is @c NET_ADDRESS_SCHEME_STATIC, @c primaryDnsAddress must be a valid IpAddress.
* However, @c pSecondaryDnsAddress can be @c null.
*
* @since 2.0
*
* @return An error code
* @param[in] dnsAddrScheme An indicator specifying whether or not to use a static DNS address
- * @param[in] pPrimaryDnsAddress The statically assigned primary DNS address if @c dnsAddrScheme is NET_ADDRESS_SCHEME_STATIC
- * @param[in] pSecondaryDnsAddress The statically assigned secondary DNS address if @c dnsAddrScheme is NET_ADDRESS_SCHEME_STATIC
+ * @param[in] pPrimaryDnsAddress The statically assigned primary DNS address if @c dnsAddrScheme is @c NET_ADDRESS_SCHEME_STATIC
+ * @param[in] pSecondaryDnsAddress The statically assigned secondary DNS address if @c dnsAddrScheme is @c NET_ADDRESS_SCHEME_STATIC
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @see GetPrimaryDnsAddress()
* For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.0
- *
- * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance.
*/
NetAccountManager(void);
* For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.0
- *
- * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance.
*/
NetConnection(void);
* @exception E_INVALID_ACCOUNT The specified network account ID is invalid.
* @exception E_SYSTEM An internal error has occurred.
* @exception E_INVALID_PROXY The proxy address is invalid.
- * @remarks If the application gets the last result by E_INVALID_PROXY, it must use a warning pop-up to notify the user.
+ * @remarks If the application gets the last result by @c E_INVALID_PROXY, it must use a warning pop-up to notify the user.
*/
result Construct(NetAccountId netAccountId);
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_OBJ_ALREADY_EXIST The listener is already added.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, @n
- * because the caller thread is a worker thread.
+ * because the caller thread is a worker thread.
*/
result AddNetConnectionListener(INetConnectionEventListener& listener);
* @exception E_INVALID_CONTEXT The context information associated with the network connection account is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM An internal error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks This method requires a NetConnectionInfo instance reference. The network connection information is only available when the network
- * connection is "Active". For other states, this method returns @c null.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - This method requires a NetConnectionInfo instance reference. The network connection information is only available when the network
+ * connection is "Active". For other states, this method returns @c null.
* @warning Do not delete the returned NetConnectionInfo instance. This instance directly references the internal connection information of
* %NetConnection.
*/
* @since 2.0\r
*\r
* The %NetConnectionInfo class provides methods to obtain information related to a network connection. %NetConnectionInfo is valid when \r
- * NetConnection is not in the "NET_CONNECTION_STATE_STOPPED" state.\r
+ * NetConnection is not in the ::NET_CONNECTION_STATE_STOPPED state.\r
*\r
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/managing_network_connections.htm">Managing Network Connections</a>.\r
*/\r
* @since 2.0\r
*\r
* @return A pointer to the IpAddress instance representing the local address in the calling instance\r
- * @remarks If GetLocalAddressScheme() is NET_ADDRESS_SCHEME_STATIC, this method returns the statically assigned local addresses. @n\r
- * If %GetLocalAddressScheme() is NET_ADDRESS_SCHEME_DYNAMIC, this method returns the dynamically assigned local addresses. @n\r
+ * @remarks If GetLocalAddressScheme() is ::NET_ADDRESS_SCHEME_STATIC, this method returns the statically assigned local addresses. @n\r
+ * If %GetLocalAddressScheme() is ::NET_ADDRESS_SCHEME_DYNAMIC, this method returns the dynamically assigned local addresses. @n\r
* In any case, check whether the IpAddress pointer is @c null or not.\r
*/\r
const IpAddress* GetLocalAddress(void) const;\r
* @since 2.0\r
*\r
* @return A pointer to the IpAddress instance representing the primary DNS Address of the network connection\r
- * @remarks If GetDnsAddressScheme() is NET_ADDRESS_SCHEME_STATIC, this method returns the statically assigned local addresses. @n\r
- * If %GetDnsAddressScheme() is NET_ADDRESS_SCHEME_DYNAMIC, this method returns the dynamically assigned local addresses. @n\r
+ * @remarks If GetDnsAddressScheme() is ::NET_ADDRESS_SCHEME_STATIC, this method returns the statically assigned local addresses. @n\r
+ * If %GetDnsAddressScheme() is ::NET_ADDRESS_SCHEME_DYNAMIC, this method returns the dynamically assigned local addresses. @n\r
* In any case, check whether the IpAddress pointer is @c null or not, because the DNS address field is not mandatory.\r
*/\r
const IpAddress* GetPrimaryDnsAddress(void) const;\r
* @since 2.0\r
*\r
* @return A pointer to the IpAddress instance representing the secondary DNS Address of the network connection\r
- * @remarks If GetDnsAddressScheme() is NET_ADDRESS_SCHEME_STATIC, this method returns the statically assigned local addresses. @n\r
- * If %GetDnsAddressScheme() is NET_ADDRESS_SCHEME_DYNAMIC, this method returns the dynamically assigned local addresses. @n\r
+ * @remarks If GetDnsAddressScheme() is ::NET_ADDRESS_SCHEME_STATIC, this method returns the statically assigned local addresses. @n\r
+ * If %GetDnsAddressScheme() is ::NET_ADDRESS_SCHEME_DYNAMIC, this method returns the dynamically assigned local addresses. @n\r
* In any case, check whether the IpAddress pointer is @c null or not, because the DNS address field is not mandatory.\r
*/\r
const IpAddress* GetSecondaryDnsAddress(void) const;\r
* For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.0
- *
- * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance.
*/
NetConnectionManager(void);
*
* @privlevel public
* @privilege %http://tizen.org/privilege/network.connection
- * @feature %http://tizen.org/feature/network.wifi for the NET_WIFI_ONLY value and @n
- * %http://tizen.org/feature/network.telephony for the NET_PS_ONLY value of @c netPreference
+ * @feature %http://tizen.org/feature/network.wifi for the @c NET_WIFI_ONLY value and @n
+ * %http://tizen.org/feature/network.telephony for the @c NET_PS_ONLY value of @c netPreference
*
* @return An error code
* @param[in] netPreference The preferred network
* else @c null string if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state.
- * @remarks The string output of this method is formatted as follows: IPADDRESS:PORT. @n
- * IPADDRESS is a string representing a number expressed in the Internet Standard "." (dotted) notation (for example, 165.213.173.7). @n
- * PORT is a string representing a port number in host byte order. For example, 165.213.173.7:2000 is a possible string. @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - The string output of this method is formatted as follows: IPADDRESS:PORT. @n
+ * IPADDRESS is a string representing a number expressed in the Internet Standard "." (dotted) notation (for example, 165.213.173.7). @n
+ * PORT is a string representing a port number in host byte order. For example, 165.213.173.7:2000 is a possible string.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::String GetNetEndPoint(void) const;
* For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.0
- *
- * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance.
*/
NetStatistics(void);
* @privlevel public
* @privilege %http://tizen.org/privilege/network.statistics @n
* (%http://tizen.org/privilege/network.statistics.read is deprecated.)
- * @feature %http://tizen.org/feature/network.wifi for the NET_BEARER_WIFI value and @n
- * %http://tizen.org/feature/network.telephony for the NET_BEARER_PS value of @c bearerType
+ * @feature %http://tizen.org/feature/network.wifi for the @c NET_BEARER_WIFI value and @n
+ * %http://tizen.org/feature/network.telephony for the @c NET_BEARER_PS value of @c bearerType
*
* @return The number of bytes sent or received, @n
* else @c INVALID_HANDLE if an error occurs
* @param[in] bearerType The bearer type of the data call operation @n
- * NET_BEARER_WIFI_DIRECT and NET_BEARER_USB are not supported.
+ * @c NET_BEARER_WIFI_DIRECT and @c NET_BEARER_USB are not supported.
* @param[in] netStatType The type of statistical information to get
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
*
* @privlevel platform
* @privilege %http://tizen.org/privilege/netstatisticsmanager
- * @feature %http://tizen.org/feature/network.wifi for the NET_BEARER_WIFI value and @n
- * %http://tizen.org/feature/network.telephony for the NET_BEARER_PS value of @c bearerType
+ * @feature %http://tizen.org/feature/network.wifi for the @c NET_BEARER_WIFI value and @n
+ * %http://tizen.org/feature/network.telephony for the @c NET_BEARER_PS value of @c bearerType
*
* @return An error code
- * @param[in] bearerType The bearer type (OperationMode) whose statistical information is reset @n NET_BEARER_WIFI_DIRECT and NET_BEARER_USB are not supported.
+ * @param[in] bearerType The bearer type (OperationMode) whose statistical information is reset @n
+ * @c NET_BEARER_WIFI_DIRECT and @c NET_BEARER_USB are not supported.
* @param[in] netStatType The type of statistical information to reset
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
*
* @privlevel platform
* @privilege %http://tizen.org/privilege/netstatisticsmanager
- * @feature %http://tizen.org/feature/network.wifi for the NET_BEARER_WIFI value and @n
- * %http://tizen.org/feature/network.telephony for the NET_BEARER_PS value of @c bearerType
+ * @feature %http://tizen.org/feature/network.wifi for the @c NET_BEARER_WIFI value and @n
+ * %http://tizen.org/feature/network.telephony for the @c NET_BEARER_PS value of @c bearerType
*
* @return An error code
- * @param[in] bearerType The bearer type (OperationMode) whose statistical information would be reset @n NET_BEARER_WIFI_DIRECT and NET_BEARER_USB are not supported.
+ * @param[in] bearerType The bearer type (OperationMode) whose statistical information would be reset @n
+ * @c NET_BEARER_WIFI_DIRECT and @c NET_BEARER_USB are not supported.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_SYSTEM An internal error has occurred.
*
* @param[in] socket The SecureSocket instance
* @param[in] reason The reason of type NetSocketClosedReason for a closed secure socket
- * @remarks If the reason is NET_SOCKET_CLOSED_REASON_NO_CERTIFICATE, start the Application control (L"tizen.certificatemanager") for getting the selected client certificate. @n
+ * @remarks If the reason is @c NET_SOCKET_CLOSED_REASON_NO_CERTIFICATE, start the Application control (L"tizen.certificatemanager") for getting the selected client certificate. @n
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/app/appcontrol_certmgr.htm">here</a>.
*/
virtual void OnSecureSocketClosed(SecureSocket& socket, NetSocketClosedReason reason) = 0;
*/
/**
- * Sends the data to a socket of the type NET_SOCKET_TYPE_STREAM.
+ * Sends the data to a socket of the type ::NET_SOCKET_TYPE_STREAM.
*
* @since 2.0
*
*
* @section SocketSendToPage2ResolutionSection Resolutions
* The issue mentioned above is resolved in %Tizen API version 2.1 as follows: @n
- * -# If the application provides a loopback address in NetEndPoint, it returns E_SUCCESS instead of E_SYSTEM.
+ * -# If the application provides a loopback address in NetEndPoint, it returns @c E_SUCCESS instead of @c E_SYSTEM.
*/
/**
- * Receives the data from a socket of the type NET_SOCKET_TYPE_STREAM.
+ * Receives the data from a socket of the type ::NET_SOCKET_TYPE_STREAM.
*
* @since 2.0
*
result Receive(Tizen::Base::ByteBuffer& buffer) const;
/**
- * Receives the data from a socket of the type NET_SOCKET_TYPE_STREAM.
+ * Receives the data from a socket of the type ::NET_SOCKET_TYPE_STREAM.
*
* @since 2.0
*
* @since 2.0
*
* The %IpMulticastRequestOption class supports the multicasting in sockets for sending and receiving multicast datagram packets.
-* For multicasting, a socket must be of type NET_SOCKET_TYPE_DATAGRAM.
+* For multicasting, a socket must be of type ::NET_SOCKET_TYPE_DATAGRAM.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/sockets.htm">Sockets Guide</a>.
*
/**
* @class LingerOption
-* @brief This class specifies whether a socket remains connected after the Socket::Close() method is called.
+* @brief This class specifies whether a socket remains connected after the %Socket::Close() method is called.
* It also specifies the amount of time for which it remains connected, if the data is not sent.
*
* @since 2.0
/**
* @class SocketUtility
-* @brief This class provides the utility methods for the Socket class.
+* @brief This class provides the utility methods for the %Socket class.
*
* @since 2.0
*
/**
* @interface IWifiDirectDeviceListener
- * @brief This interface implements listeners for the WifiDirectDevice events.
+ * @brief This interface implements listeners for the %WifiDirectDevice events.
*
* @since 2.0
*
{
/**
* @interface IWifiManagerEventListener
- * @brief This interface provides the listeners for WifiManager events.
+ * @brief This interface provides the listeners for %WifiManager events.
*
* @since 2.0
*
// limitations under the License.
//
/**
+ * @if OSPDEPREC
* @file FNetWifiWifiDirectGroupOwner.h
* @brief This is the header file for the %WifiDirectGroupOwner class.
*
* This header file contains the declarations of the %WifiDirectGroupOwner class.
+ * @endif
*/
#ifndef _FNET_WIFI_WIFI_DIRECT_GROUP_OWNER_H_
#define _FNET_WIFI_WIFI_DIRECT_GROUP_OWNER_H_
projects / platform / framework / native / net.git / commitdiff