*
* @return @c true if the values match, @n
* else @c false
- * @param[in] rhs The other Object to compare
- * @see Object::Equals()
+ * @param[in] rhs The other Tizen::Base::Object to compare
+ * @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
result Construct(const NetConnection& netConnection, IDnsEventListener& listener);
/**
- * Initializes this instance of %Dns with the specified listener.
+ * Initializes this instance of %Dns with the specified @c listener.
*
* @since 2.0
*
public:
/**
* Requests a DNS lookup by host name. @n
- * This method is asynchronous.
+ * The %GetHostByName() method is asynchronous.
*
* @since 2.0
*
/**
* Requests a DNS lookup by IP address. @n
- * This method is asynchronous.
+ * The %GetHostByAddress() method is asynchronous.
*
* @since 2.0
*
protected:
/**
* Writes the message body. @n
- * This method can be called several times consecutively. All the message bodies are stored in the queue.
+ * The %WriteBody() method can be called several times consecutively. All the message bodies are stored in the queue.
*
* @since 2.0
*
protected:
/**
* Gets the header. @n
- * This method is used to access the headers associated with a transaction request or response.
+ * The %GetHeader() method is used to access the headers associated with a transaction request or response.
* The handle is obtained from either the HttpRequest or the HttpResponse objects associated with the transaction. Adding, modifying, or removing a
* header field is done using this header handle.
*
//
// This variable is for internal use only. Using this variable can cause behavioral, security-related, and consistency-related issues in the application.
//
- // The header of message
+ // The header of the message
//
// @since 2.0
//
result AddStringPart(const Tizen::Base::String& name, const Tizen::Base::String& text);
/**
- * Adds the string part to the %HttpMultipartEntity.
+ * Adds the string part to %HttpMultipartEntity.
*
* @since 2.0
*
result SetTimeout(int timeout);
/**
- * Sets the flag to verify server certificate. (the flag is @c HTTP_CV_FLAG_AUTOMATIC by default)
+ * Sets the flag to verify server certificate. (By default, the flag is @c HTTP_CV_FLAG_AUTOMATIC.)
*
* @since 2.1
*
* @return An error code
- * @param[in] flag Set the flag for certificate verification.
+ * @param[in] flag Set the flag for certificate verification
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The method invoked is invalid.
* @exception E_SYSTEM A system error has occurred.
/**
* @enum HttpVersion
*
- * Defines the HTTP version
+ * Defines the HTTP version.
*
* @since 2.0
*/
*/
enum NetHttpCertificateVerificationFlag
{
- HTTP_CV_FLAG_AUTOMATIC, /**< The certificate will be verified by system. If server certificate is invalid, the IHttpTransactionEventListener::OnTransactionCertVerificationRequiredN() listener is received. */
- HTTP_CV_FLAG_MANUAL, /**< The certificate verification will be handled by user action when the IHttpTransactionEventListener::OnTransactionCertVerificationRequestedN() listener is received. */
- HTTP_CV_FLAG_IGNORED, /**< The certificate verification will be ignored. */
+ HTTP_CV_FLAG_AUTOMATIC, /**< The certificate is verified by the system @n If server certificate is invalid, the IHttpTransactionEventListener::OnTransactionCertVerificationRequiredN() listener is received. */
+ HTTP_CV_FLAG_MANUAL, /**< The certificate verification is handled by user action when the IHttpTransactionEventListener::OnTransactionCertVerificationRequestedN() listener is received */
+ HTTP_CV_FLAG_IGNORED, /**< The certificate verification is ignored */
};
} } } //Tizen::Net::Http
* @since 2.0
*
* The %IHttpProgressEventListener interface is the listener for the HTTP progress events, when the HTTP message is uploaded or downloaded. In order to use this listener,
- * the listener must be set to the HttpTransaction instance using the SetHttpProgressListener() method.
+ * the listener must be set to the HttpTransaction instance using the HttpTransaction::SetHttpProgressListener() method.
*/
class _OSP_EXPORT_ IHttpProgressEventListener
* Called to notify when the server certificate verification has been requested.
*
* @since 2.1
- * @return The result for certificate verification.
*
+ * @return The result for certificate verification
* @param[in] httpSession The session information of the %Http transaction event
* @param[in] httpTransaction The transaction information of the %Http transaction event
- * @param[in] pCertList The server certificate chain. An IList whose element is of the type Tizen::Security::Cert::X509Certificate *.
+ * @param[in] pCertList The server certificate chain @n A Tizen::Base::Collection::IList whose element is of the type Tizen::Security::Cert::X509Certificate *.
*
- * @remarks Do not delete instance of @c httpSession or @c httpTransaction in this listener before the IHttpTransactionEventListener::OnTransactionCompleted() or IHttpTransactionEventListener::OnTransactionAborted() method is called.
+ * @remarks Do not delete the instance of @c httpSession or @c httpTransaction in this listener before the IHttpTransactionEventListener::OnTransactionCompleted() or IHttpTransactionEventListener::OnTransactionAborted() method is called.
* @see HttpTransaction::SetServerCertificateVerification()
*/
virtual bool OnTransactionCertVerificationRequestedN(HttpSession& httpSession, HttpTransaction& httpTransaction, Tizen::Base::Collection::IList* pCertList)
* @file FNetILocalDhcpServerEventListener.h
* @brief This is the header file for the %ILocalDhcpServerEventListener interface.
*
- * This is the header file for the %ILocalDhcpServerEventListener interface.
+ * This header file contains the declarations of the %ILocalDhcpServerEventListener interface.
*
*/
#ifndef _FNET_ILOCAL_DHCP_SERVER_EVENT_LISTENER_H_
*
* The %IManagedNetConnectionEventListener interface specifies the methods used to create the notifications about the different kinds of network
* connection events. These events are sent only when %IManagedNetConnectionEventListener is added to the ManagedNetConnection instance, and
- * this is done by invoking the SetManagedNetConnectionEventListener() method. A method of this interface is called when a network connection
+ * this is done by invoking the ManagedNetConnection::SetManagedNetConnectionEventListener() method. A method of this interface is called when a network connection
* event is generated.
*
* 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>.
*
* The %INetConnectionEventListener interface specifies the methods for creating the notifications about the different kinds of network
* connection events. These events are only sent when %INetConnectionEventListener is added to a NetConnection instance, by invoking the
- * AddNetConnectionListener() method. When a network connection event is generated, a method of this class is called.
+ * NetConnection::AddNetConnectionListener() method. When a network connection event is generated, a method of this class is called.
*
* 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>.
*
* @since 2.0
*
* @return An error code
- * @param[out] ipAddr A ByteBuffer object containing the raw IP address
+ * @param[out] ipAddr A Tizen::Base::ByteBuffer object containing the raw IP address
* @exception E_SUCCESS The method is successful.
* @exception E_OVERFLOW The length of the remaining bytes of @c ipAddr is less than @c 4.
* @remarks This method returns the raw IP address of the %Ip4Address object. The result is in host byte order. This method writes the raw address
*
* @return @c true if the values match, @n
* else @c false
- * @param[in] rhs The other Object to be compared
- * @see Object::Equals()
+ * @param[in] rhs The other Tizen::Base::Object to compare
+ * @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
*
* @since 2.0
*
- * @return The current instance's hash value
+ * @return The hash value of the current instance
*/
virtual int GetHashCode(void) const;
* @since 2.0
*
* @return The address as an unsigned @c short value, in the network @c byte order
- * @param[in] host The IP address to be converted, expressed in host @c byte order
+ * @param[in] host The IP address to convert, expressed in host @c byte order
*
* @see NetworkToHostOrder()
*/
* @since 2.0
*
* @return The address as an unsigned @c long value, in the network @c byte order
- * @param[in] host The IP address to be converted, expressed in host @c byte order
+ * @param[in] host The IP address to convert, expressed in the host @c byte order
*
* @see NetworkToHostOrder()
*/
* @since 2.0
*
* @return The address as an unsigned @c short value, in the host @c byte order
- * @param[in] network The IP address to be converted, expressed in the network @c byte order
+ * @param[in] network The IP address to convert, expressed in the network @c byte order
*
* @see HostToNetworkOrder()
*/
* @since 2.0
*
* @return The address as an unsigned @c long value, in the host @c byte order
- * @param[in] network The IP address to be converted, expressed in the network @c byte order
+ * @param[in] network The IP address to convert, expressed in the network @c byte order
*
* @see HostToNetworkOrder()
*/
* @since 2.0
*
* @return An error code
- * @param[out] ipAddr A ByteBuffer object for getting the raw IP address
+ * @param[out] ipAddr A Tizen::Base::ByteBuffer object for getting the raw IP address
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c ipAddr is invalid.
* @exception E_OVERFLOW This operation has caused the memory to overflow.
* @since 2.0
*
* The %IpHostEntry class associates a Domain Name %System (DNS) host name with a list of aliases and matching IP addresses. If the specified host has
- * multiple entries in the DNS database, %IpHostEntry contains multiple IP addresses and aliases. The %IpHostEntry class is used as a helper class
+ * multiple entries in the DNS database, %IpHostEntry contains multiple IP addresses and aliases. This class is used as a helper class
* with the Dns class.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/domain_name_system_access.htm">Domain Name System Access</a>.
* @return A pointer to an instance of NetConnectionInfo specifying the information about this network connection\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_STATE The network connection is inactive.\r
- * @remarks This method requires a %NetConnectionInfo instance reference.\r
+ * @remarks This method requires a NetConnectionInfo instance reference.\r
* %NetConnectionInfo is only available when the network connection managed by the system is active. In other states, this returns null.\r
* The specific error code can be accessed using the GetLastResult() method.\r
- * @warning Do not delete the returned %NetConnectionInfo instance. This instance is directly referencing the internal connectionInfo of \r
+ * @warning Do not delete the returned NetConnectionInfo instance. This instance is directly referencing the internal connectionInfo of \r
* %ManagedNetConnection.\r
*/\r
const NetConnectionInfo* GetNetConnectionInfo(void) const;\r
* 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 @ref 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 NET_ADDRESS_SCHEME_DYNAMIC @n
+ * - 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()
*/
*
* @return @c true if the values match, @n
* else @c false
- * @param[in] rhs The other Object to compare
- * @see Object::Equals()
+ * @param[in] rhs The other Tizen::Base::Object to compare
+ * @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
*
* @since 2.0
*
- * @return An IList with NetAccoundIds, which are in the registry
+ * @return A Tizen::Base::Collection::IList with NetAccoundIds, which are in the registry
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The NetAccountInfo is not found in the registry.
* @exception E_SYSTEM An internal error has occurred.
*
* @since 2.0
*
- * @return An IList containing the indexes to the NetAccountInfos in the registry
+ * @return A Tizen::Base::Collection::IList containing the indexes to the NetAccountInfos in the registry
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The NetAccountInfo is not found in the registry.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SERVICE_LIMITED A connection is already active. Therefore, cannot setup a co-existing network connection.
* @exception E_SYSTEM An internal error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks When the network is available, after calling this method, the OnNetConnectionStarted() method of the registered
+ * @remarks When the network is available, after calling this method, the INetConnectionEventListener::OnNetConnectionStarted() method of the registered
* INetConnectionEventListener instance is called.
* @see Stop()
*/
* @deprecated This method is deprecated because it is moved to the NetConnectionManager class.
* @since 2.0
*
- * @return An IList containing indexes to NetConnectionInfo in the network, @n
+ * @return A Tizen::Base::Collection::IList containing indexes to NetConnectionInfo in the network, @n
* else @c null in case of an error or if an active connection is not found
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @since 2.0\r
*\r
* @return A pointer to the IpAddress instance representing the subnet mask address of the network connection\r
- * @remarks In any case, check whether the %IpAddress pointer is @c null or not, because the subnet mask address field is not mandatory.\r
+ * @remarks In any case, check whether the IpAddress pointer is @c null or not, because the subnet mask address field is not mandatory.\r
*/\r
const IpAddress* GetSubnetMaskAddress(void) const;\r
\r
*\r
* @return @c true if the values match, @n\r
* else @c false\r
- * @param[in] rhs The other Object to compare\r
- * @see Object::Equals()\r
+ * @param[in] rhs The other Tizen::Base::Object to compare\r
+ * @see Tizen::Base::Object::Equals()\r
*/\r
virtual bool Equals(const Tizen::Base::Object& rhs) const;\r
\r
*
* @since 2.0
*
- * @return An IList containing indexes to the active %NetConnectionInfo in the network, @n
+ * @return A Tizen::Base::Collection::IList containing indexes to the active %NetConnectionInfo in the network, @n
* else @c null if there is an error or if there is no active connection in the system
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*
* @return @c true if the values match, @n
* else @c false
- * @param[in] rhs The other Object to compare
- * @see Object::Equals()
+ * @param[in] rhs The other Tizen::Base::Object to compare
+ * @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
/**
* @enum NetProxyType
*
- * Defines the proxy type of the network
+ * Defines the proxy type of the network.
*
* @since 2.0
*/
enum NetProxyType
{
- NET_PROXY_TYPE_NONE = 0, /**< Not use a proxy */
+ NET_PROXY_TYPE_NONE = 0, /**< No use of proxy */
NET_PROXY_TYPE_MANUAL /**< Manual configuration */
};
* @since 2.0
*
* The %ISocketEventListener interface specifies methods used for creating notifications about the different kinds of socket events.
-* These events are only sent out when using the socket in a non-blocking mode. A listener is registered by calling the AddSocketListener()
+* These events are only sent out when using the socket in a non-blocking mode. A listener is registered by calling the Socket::AddSocketListener()
* method. One of these methods is called when a socket event is generated.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/sockets.htm">Sockets Guide</a>.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*
* @remarks Starts connection to a remote peer including SSL handshaking.
- * After this method is called, OnSecureSocketConnected() is called. The data is sent to and received from the remote
+ * After this method is called, ISecureSocketEventListener::OnSecureSocketConnected() is called. The data is sent to and received from the remote
* device using Send() and Receive() respectively. If the Bind() method is not called before calling this
* method, the underlying service provider assigns the local network address and port number.
*/
* @since 2.0
*
* @return An error code
- * @param[in] buffer An instance of ByteBuffer that contains the data to send
+ * @param[in] buffer An instance of Tizen::Base::ByteBuffer that contains the data to send
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_SOCKET The secure socket is invalid.
* @exception E_INVALID_STATE The secure socket is not in a valid state.
* @since 2.0
*
* @return An error code
- * @param[out] buffer An instance of ByteBuffer that is the storage location for the received data
+ * @param[out] buffer An instance of Tizen::Base::ByteBuffer that is the storage location for the received data
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_SOCKET The secure socket is invalid.
* @exception E_INVALID_STATE The secure socket is not in a valid state.
/**
* Accepts an incoming connection. @n
- * This method extracts the first connection from the queue of pending connections, and
+ * The %AcceptN() method extracts the first connection from the queue of pending connections, and
* creates a new secure socket with the same socket type, protocol type, and protocol family
* as the listening secure socket.
*
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks If the socket is a connectionless socket (that is, of the type NET_SOCKET_TYPE_DATAGRAM), this method fails.
- * After this method is called, OnSocketConnected() is called. the data can be sent to and received from the remote device using Send() and Receive() respectively.
+ * After this method is called, ISocketEventListener::OnSocketConnected() is called. the data can be sent to and received from the remote device using Send() and Receive() respectively.
* If a connection-oriented protocol is used and Bind() is not called before calling this method, the underlying service provider
* assigns the local network address and port number.
*/
* @since 2.0
*
* @return An error code
- * @param[in] buffer An instance of ByteBuffer that contains the data to be sent
+ * @param[in] buffer An instance of Tizen::Base::ByteBuffer that contains the data to send
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_SOCKET The socket is invalid.
* @exception E_INVALID_STATE The socket is not in a valid state.
* @endif
*
* @return An error code
- * @param[in] buffer An instance of ByteBuffer containing the data to send
+ * @param[in] buffer An instance of Tizen::Base::ByteBuffer containing the data to send
* @param[in] remoteEndPoint An instance of NetEndPoint representing the destination for the data
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_SOCKET The socket is invalid.
* @since 2.0
*
* @return An error code
- * @param[out] buffer An instance of ByteBuffer that is the storage location for the received data
+ * @param[out] buffer An instance of Tizen::Base::ByteBuffer that is the storage location for the received data
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_SOCKET The socket is invalid.
* @exception E_INVALID_STATE The socket is not in a valid state.
* @endif
*
* @return An error code
- * @param[out] buffer An instance of ByteBuffer that is the storage location for the received data
+ * @param[out] buffer An instance of Tizen::Base::ByteBuffer that is the storage location for the received data
* @param[out] remoteEndPoint The NetEndPoint of the remote server
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_SOCKET The socket is invalid.
* @since 2.0
* @return @c true if the values match, @n
* else @c false
- * @param[in] obj The other Object to be compared
- * @see Object::Equals()
+ * @param[in] obj The other Tizen::Base::Object to compare
+ * @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Tizen::Base::Object& obj) const;
*
* @return @c true if the values match, @n
* else @c false
- * @param[in] obj The other Object to be compared
- * @see Object::Equals()
+ * @param[in] obj The other Tizen::Base::Object to compare
+ * @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Tizen::Base::Object& obj) const;
* @privilege http://tizen.org/privilege/socket
*
* @return An error code
- * @param[in,out] pCheckRead An IList of Socket instances to check for readability
- * @param[in,out] pCheckWrite An IList of Socket instances to check for writability
- * @param[in,out] pCheckError An IList of Socket instances to check for errors
+ * @param[in,out] pCheckRead A Tizen::Base::Collection::IList of Socket instances to check for readability
+ * @param[in,out] pCheckWrite A Tizen::Base::Collection::IList of Socket instances to check for writability
+ * @param[in,out] pCheckError A Tizen::Base::Collection::IList of Socket instances to check for errors
* @param[in] microSeconds The time to wait for a response, in microseconds
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_SOCKET The socket is invalid.
* @exception E_SYSTEM A system error has occurred.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks This method determines the status of one or more
- * Socket instances. There must be at least one socket in an IList
+ * Socket instances. There must be at least one socket in an Tizen::Base::Collection::IList
* before this method is used.
* To check sockets for readability and writability use @c pCheckRead and @c pCheckWrite of type
* %IList respectively by calling this method.
projects / framework / osp / net.git / commitdiff