NetConnection

Overview

Provides the C APIs of the network connection module for network management.

Since: 11

Summary

File

Name	Description
net_connection.h	Provides the C APIs of the network connection module for network management. File to include: <network\/netmanager\/net_connection.h>
net_connection_type.h	Declares the structs for the C APIs of the network connection module. File to include: <network\/netmanager\/net_connection_type.h>

Structs

Name	Description
NetConn_NetHandle	Network ID.
NetConn_NetCapabilities	Network capability set.
NetConn_NetAddr	Network address.
NetConn_Route	Route configuration.
NetConn_HttpProxy	Proxy configuration.
NetConn_ConnectionProperties	Network connection information.
NetConn_NetHandleList	Network list.
NetConn_NetConnCallback	Defines network status callbacks.
NetConn_NetSpecifier	Defines the network feature set, including a network capability set and a network ID.

Macros

Name	Description
NETCONN_MAX_NET_SIZE	32
NETCONN_MAX_BEARER_TYPE_SIZE	32
NETCONN_MAX_CAP_SIZE	32
NETCONN_MAX_ADDR_SIZE	32
NETCONN_MAX_ROUTE_SIZE	64
NETCONN_MAX_EXCLUSION_SIZE	256
NETCONN_MAX_STR_LEN	256

Types

Name	Description
NetConn_NetCap	Network capability set.
NetConn_NetBearerType	Network carrier type.
NetConn_NetHandle	Network ID.
NetConn_NetCapabilities	Network capability set.
NetConn_NetAddr	Network address.
NetConn_Route	Route configuration.
NetConn_HttpProxy	Proxy configuration.
NetConn_ConnectionProperties	Network connection information.
NetConn_NetHandleList	Network list.
(*OH_NetConn_CustomDnsResolver) (const char *host, const char *serv, const struct addrinfo *hint, struct addrinfo **res)	Pointer to the custom DNS resolver.
NetConn_NetConnCallback	Defines network status callbacks.
NetConn_NetSpecifier	Defines the network feature set, including a network capability set and a network ID.
NetConn_ErrorCode	Network connection error code.

Enums

Name	Description
NetConn_NetCap { NETCONN_NET_CAPABILITY_MMS = 0, NETCONN_NET_CAPABILITY_NOT_METERED = 11, NETCONN_NET_CAPABILITY_INTERNET = 12, NETCONN_NET_CAPABILITY_NOT_VPN = 15, NETCONN_NET_CAPABILITY_VALIDATED = 16 }	Network capability set.
NetConn_NetBearerType { NETCONN_BEARER_CELLULAR = 0, NETCONN_BEARER_WIFI = 1, NETCONN_BEARER_ETHERNET = 3 NETCONN_BEARER_VPN = 4 }	Network carrier type.
NetConn_ErrorCode { NETCONN_SUCCESS = 0, NETCONN_PERMISSION_DENIED = 201, NETCONN_PARAMETER_ERROR = 401, NETCONN_OPERATION_FAILED = 2100002, NETCONN_INTERNAL_ERROR= 2100003 }	Network connection error code.

Functions

Name	Description
OH_NetConn_HasDefaultNet (int32_t *hasDefaultNet)	Checks whether a default activated data network is available.
OH_NetConn_GetDefaultNet (NetConn_NetHandle *netHandle)	Obtains the default activated data network.
OH_NetConn_IsDefaultNetMetered (int32_t *isMetered)	Checks whether data traffic usage on the current network is metered.
OH_NetConn_GetConnectionProperties (NetConn_NetHandle *netHandle, NetConn_ConnectionProperties *prop)	Obtains the link information of a data network.
OH_NetConn_GetNetCapabilities (NetConn_NetHandle *netHandle, NetConn_NetCapabilities *netCapacities)	Obtains the capabilities of a data network.
OH_NetConn_GetDefaultHttpProxy (NetConn_HttpProxy *httpProxy)	Obtains the default network proxy.
OH_NetConn_GetAddrInfo (char *host, char *serv, struct addrinfo *hint, struct addrinfo **res, int32_t netId)	Obtains the DNS result using netId.
OH_NetConn_FreeDnsResult (struct addrinfo *res)	Releases the DNS query result.
OH_NetConn_GetAllNets (NetConn_NetHandleList *netHandleList)	Obtains all activated data networks.
OHOS_NetConn_RegisterDnsResolver (OH_NetConn_CustomDnsResolver resolver)	Registers a custom DNS resolver.
OHOS_NetConn_UnregisterDnsResolver (void)	Unregisters a custom DNS resolver.
OH_NetConn_RegisterDnsResolver (OH_NetConn_CustomDnsResolver resolver)	Registers a custom DNS resolver.
OH_NetConn_UnregisterDnsResolver (void)	Unregisters a custom DNS resolver.
OH_NetConn_BindSocket (int32_t socketFd, NetConn_NetHandle *netHandle)	Binds a socket to the specified network.
OH_NetConn_SetAppHttpProxy (NetConn_HttpProxy *httpProxy)	Sets the application-level HTTP proxy information.
OH_NetConn_RegisterAppHttpProxyCallback (OH_NetConn_AppHttpProxyChange appHttpProxyChange, uint32_t *callbackId)	Registers a listener for application-level proxy changes.
OH_NetConn_UnregisterAppHttpProxyCallback (uint32_t callbackId)	Unregisters the listener for application-level proxy changes.
OH_NetConn_RegisterNetConnCallback (NetConn_NetSpecifier *specifier, NetConn_NetConnCallback *netConnCallback, uint32_t timeoutMS, uint32_t *callbackId)	Registers a callback for network status changes.
OH_NetConn_RegisterDefaultNetConnCallback (NetConn_NetConnCallback *netConnCallback, uint32_t *callbackId)	Registers a callback for status changes of the default network.
OH_NetConn_UnregisterNetConnCallback (uint32_t callbackId)	Unregisters the callback for network status changes.
OH_NetConn_SetPacUrl (const char *pacUrl)	Sets the URL of the system-level proxy auto-config (PAC) script.
OH_NetConn_GetPacUrl (char *pacUrl)	Obtains the URL of the system-level PAC script.

Type Description

NetConn_ConnectionProperties

typedef struct NetConn_ConnectionProperties NetConn_ConnectionProperties

Description

Network connection information.

Since: 11

NetConn_HttpProxy

typedef struct NetConn_HttpProxy NetConn_HttpProxy

Description

Proxy configuration.

Since: 11

NetConn_NetAddr

typedef struct NetConn_NetAddr NetConn_NetAddr

Description

Network address.

Since: 11

NetConn_NetBearerType

typedef enum NetConn_NetBearerType NetConn_NetBearerType

Description

Network carrier type.

Since: 11

NetConn_NetCap

typedef enum NetConn_NetCap NetConn_NetCap

Description

Network capability set.

Since: 11

NetConn_NetCapabilities

typedef struct NetConn_NetCapabilities NetConn_NetCapabilities

Description

Network capability set.

Since: 11

NetConn_NetHandle

typedef struct NetConn_NetHandle NetConn_NetHandle

Description

Network ID.

Since: 11

NetConn_NetHandleList

typedef struct NetConn_NetHandleList NetConn_NetHandleList

Description

Network list.

Since: 11

NetConn_Route

typedef struct NetConn_Route NetConn_Route

Description

Route configuration.

Since: 11

OH_NetConn_CustomDnsResolver

typedef int(* OH_NetConn_CustomDnsResolver) (const char *host, const char *serv, const struct addrinfo *hint, struct addrinfo **res)

Description

Pointer to the custom DNS resolver.

Since: 11

Parameters

Name	Description
host	Host name.
serv	Service name.
hint	Pointer to the addrinfo structure.
res	DNS query result, which is in the format of linked lists.

OH_NetConn_AppHttpProxyChange

typedef void(* OH_NetConn_AppHttpProxyChange) (NetConn_HttpProxy *proxy)

Description

Defines the callback for application-level proxy changes.

Since: 12

Parameters

Name	Description
proxy	Proxy configuration information (probably a null pointer).

NetConn_NetConnCallback

typedef struct NetConn_NetConnCallback NetConn_NetConnCallback

Description

Defines network status callbacks.

Since: 12

NetConn_NetSpecifier

typedef struct NetConn_NetSpecifier NetConn_NetSpecifier

Description

Defines the network feature set, including a network capability set and a network ID.

Since: 12

NetConn_ErrorCode

typedef enum NetConn_ErrorCode NetConn_ErrorCode

Description

Enumerates network connection error codes.

Since: 15

Enum Description

NetConn_NetBearerType

enum NetConn_NetBearerType

Description

Network carrier type.

Since: 11

Value	Description
NETCONN_BEARER_CELLULAR	Cellular network.
NETCONN_BEARER_WIFI	Wi-Fi.
NETCONN_BEARER_BLUETOOTH	Bluetooth. Since: 12
NETCONN_BEARER_ETHERNET	Ethernet.
NETCONN_BEARER_VPN	Virtual private network. Since: 12

NetConn_NetCap

enum NetConn_NetCap

Description

Network capability set.

Since: 11

Value	Description
NETCONN_NET_CAPABILITY_MMS	MMS.
NETCONN_NET_CAPABILITY_NOT_METERED	Non-metered network.
NETCONN_NET_CAPABILITY_INTERNET	Internet.
NETCONN_NET_CAPABILITY_NOT_VPN	Non-VPN.
NETCONN_NET_CAPABILITY_VALIDATED	Verified.
NETCONN_NET_CAPABILITY_CHECKING_CONNECTIVITY	Connectivity check. Since: 12

NetConn_ErrorCode

enum NetConn_ErrorCode

Description

Enumerates network connection error codes.

Since: 15

Value	Description
NETCONN_SUCCESS	Success.
NETCONN_PERMISSION_DENIED	Permission verification failed.
NETCONN_PARAMETER_ERROR	Parameter check failed.
NETCONN_OPERATION_FAILED	Service connection failed.
NETCONN_INTERNAL_ERROR	Internal server error.

Function Description

OH_NetConn_FreeDnsResult()

int32_t OH_NetConn_FreeDnsResult (struct addrinfo * res)

Description

Releases the DNS query result.

System capability: SystemCapability.Communication.NetManager.Core

Since: 11

Parameters

Name	Description
res	Header of the DNS query result, which is in the format of linked lists.

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

Required permissions:

ohos.permission.INTERNET

OH_NetConn_GetAddrInfo()

int32_t OH_NetConn_GetAddrInfo (char * host, char * serv, struct addrinfo * hint, struct addrinfo ** res, int32_t netId )

Description

Obtains the DNS result using netId.

System capability: SystemCapability.Communication.NetManager.Core

Since: 11

Parameters

Name	Description
host	Host name.
serv	Service name.
hint	Pointer to the addrinfo structure.
res	DNS query result, which is in the format of linked lists.
netId	If netId is set to 0, the default netid is used for query.

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

Required permissions:

ohos.permission.INTERNET

OH_NetConn_GetAllNets()

int32_t OH_NetConn_GetAllNets (NetConn_NetHandleList * netHandleList)

Description

Obtains all activated data networks.

System capability: SystemCapability.Communication.NetManager.Core

Since: 11

Parameters

Name	Description
netHandleList	Network information list.

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

Required permissions:

ohos.permission.GET_NETWORK_INFO

OH_NetConn_GetConnectionProperties()

int32_t OH_NetConn_GetConnectionProperties (NetConn_NetHandle * netHandle, NetConn_ConnectionProperties * prop )

Description

Obtains the link information of a data network.

System capability: SystemCapability.Communication.NetManager.Core

Since: 11

Parameters

Name	Description
nethandle	Network ID.
prop	Link information.

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

Required permissions:

ohos.permission.GET_NETWORK_INFO

OH_NetConn_GetDefaultHttpProxy()

int32_t OH_NetConn_GetDefaultHttpProxy (NetConn_HttpProxy * httpProxy)

Description

Obtains the default network proxy.

System capability: SystemCapability.Communication.NetManager.Core

Since: 11

Parameters

Name	Description
httpProxy	Proxy configuration.

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

OH_NetConn_GetDefaultNet()

int32_t OH_NetConn_GetDefaultNet (NetConn_NetHandle * netHandle)

Description

Obtains the default activated data network.

System capability: SystemCapability.Communication.NetManager.Core

Since: 11

Parameters

Name	Description
netHandle	Network ID.

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

Required permissions:

ohos.permission.GET_NETWORK_INFO

OH_NetConn_GetNetCapabilities()

int32_t OH_NetConn_GetNetCapabilities (NetConn_NetHandle * netHandle, NetConn_NetCapabilities * netCapacities )

Description

Obtains the capabilities of a data network.

System capability: SystemCapability.Communication.NetManager.Core

Since: 11

Parameters

Name	Description
netHandle	Network ID.
netCapacities	Capability set.

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

Required permissions:

ohos.permission.GET_NETWORK_INFO

OH_NetConn_HasDefaultNet()

int32_t OH_NetConn_HasDefaultNet (int32_t * hasDefaultNet)

Description

Checks whether a default activated data network is available.

System capability: SystemCapability.Communication.NetManager.Core

Since: 11

Parameters

Name	Description
hasDefaultNet	Whether there is a default network.

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

Required permissions:

ohos.permission.GET_NETWORK_INFO

OH_NetConn_IsDefaultNetMetered()

int32_t OH_NetConn_IsDefaultNetMetered (int32_t * isMetered)

Description

Checks whether metering is enabled for the default data network.

System capability: SystemCapability.Communication.NetManager.Core

Since: 11

Parameters

Name	Description
isMetered	Whether metering is enabled.

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

Required permissions:

ohos.permission.GET_NETWORK_INFO

OHOS_NetConn_RegisterDnsResolver() ^(deprecated)

int32_t OHOS_NetConn_RegisterDnsResolver (OH_NetConn_CustomDnsResolver resolver)

Description

Registers a custom DNS resolver.

System capability: SystemCapability.Communication.NetManager.Core

Since: 11

Deprecated from: 13

Substitute API: OH_NetConn_RegisterDnsResolver

Parameters

Name	Description
resolver	Pointer to the custom DNS resolver.

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

Required permissions:

ohos.permission.INTERNET

OHOS_NetConn_UnregisterDnsResolver() ^(deprecated)

int32_t OHOS_NetConn_UnregisterDnsResolver (void )

Description

Unregisters a custom DNS resolver.

System capability: SystemCapability.Communication.NetManager.Core

Since: 11

Deprecated from: 13

Substitute API: OH_NetConn_UnregisterDnsResolver

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

Required permissions:

ohos.permission.INTERNET

OH_NetConn_RegisterDnsResolver()

int32_t OH_NetConn_RegisterDnsResolver (OH_NetConn_CustomDnsResolver resolver)

Description

Registers a custom DNS resolver.

System capability: SystemCapability.Communication.NetManager.Core

Since: 13

Parameters

Name	Description
resolver	Pointer to the custom DNS resolver.

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

Required permissions:

ohos.permission.INTERNET

OH_NetConn_UnregisterDnsResolver()

int32_t OH_NetConn_UnregisterDnsResolver (void )

Description

Unregisters a custom DNS resolver.

System capability: SystemCapability.Communication.NetManager.Core

Since: 13

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

Required permissions:

ohos.permission.INTERNET

OH_NetConn_BindSocket()

int32_t OH_NetConn_BindSocket (int32_t socketFd, NetConn_NetHandle * netHandle)

Description

Binds a socket to the specified network.

System capability: SystemCapability.Communication.NetManager.Core

Since: 12

Parameters

Name	Description
socketFd	File descriptor of the socket created by the user.
netHandle	Network ID.

Returns

0: success.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

OH_NetConn_SetAppHttpProxy()

int32_t OH_NetConn_SetAppHttpProxy(NetConn_HttpProxy *httpProxy)

Description

Sets the application-level proxy configuration.

System capability: SystemCapability.Communication.NetManager.Core

Since: 12

Parameters

Name	Description
httpProxy	Application-level proxy configuration.

Returns

0: success.

401: parameter error.

OH_NetConn_RegisterAppHttpProxyCallback()

int32_t OH_NetConn_RegisterAppHttpProxyCallback(OH_NetConn_AppHttpProxyChange appHttpProxyChange, uint32_t *callbackId)

Description

Registers a callback for application-level proxy changes.

System capability: SystemCapability.Communication.NetManager.Core

Since: 12

Parameters

Name	Description
appHttpProxyChange	Pointer to the callback for application-level proxy changes.
callbackId	Callback ID.

Returns

0: success.

401: parameter error.

OH_NetConn_UnregisterAppHttpProxyCallback()

void OH_NetConn_UnregisterAppHttpProxyCallback(uint32_t callbackId)

Description

Unregisters the callback for application-level proxy changes.

System capability: SystemCapability.Communication.NetManager.Core

Since: 12

Parameters

Name	Description
callbackId	Callback ID, which is obtained during registration.

OH_NetConn_RegisterNetConnCallback()

int32_t OH_NetConn_RegisterNetConnCallback(NetConn_NetSpecifier *specifier, NetConn_NetConnCallback *netConnCallback, uint32_t timeout, uint32_t *callbackId)

Description

Registers a callback to for status changes of the specified network.

System capability: SystemCapability.Communication.NetManager.Core

Since: 12

Parameters

Name	Description
specifier	Network feature set.
netConnCallback	Registered callbacks.
timeout	Waiting time, in milliseconds. The value 0 indicates infinite waiting.
callbackId	Callback IDs.

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

2101008: The callback has been registered.

2101022: The maximum number of requests is exceeded.

Required permissions:

ohos.permission.GET_NETWORK_INFO

OH_NetConn_RegisterDefaultNetConnCallback()

int32_t OH_NetConn_RegisterDefaultNetConnCallback(NetConn_NetConnCallback *netConnCallback, uint32_t *callbackId)

Description

Registers a callback to for status changes of the default network.

System capability: SystemCapability.Communication.NetManager.Core

Since: 12

Parameters

Name	Description
netConnCallback	Registered callbacks.
callbackId	Callback IDs.

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

2101008: The callback has been registered.

2101022: The maximum number of requests is exceeded.

Required permissions:

ohos.permission.GET_NETWORK_INFO

OH_NetConn_UnregisterNetConnCallback()

int32_t OH_NetConn_UnregisterNetConnCallback(uint32_t callBackId)

Description

Unregisters the callback for network status changes.

System capability: SystemCapability.Communication.NetManager.Core

Since: 12

Parameters

Name	Description
callBackId	Callback ID.

Returns

0: success.

201: no permission.

401: parameter error.

2100002: failed to connect to the service.

2100003: internal error.

2101007: The corresponding callback is not found.

Required permissions:

ohos.permission.GET_NETWORK_INFO

OH_NetConn_SetPacUrl()

NetConn_ErrorCode OH_NetConn_SetPacUrl(const char *pacUrl)

Description

Sets the URL of the system-level proxy auto-config (PAC) script.

System capability: SystemCapability.Communication.NetManager.Core

Since: 15

Parameters

Name	Description
pacUrl	URL of the PAC script. Note that this URL will not be verified by the API.

Returns

NETCONN_SUCCESS: success.

NETCONN_PERMISSION_DENIED: no permission.

NETCONN_PARAMETER_ERROR: invalid parameter.

NETCONN_OPERATION_FAILED: service connection failed.

NETCONN_INTERNAL_ERROR: internal error.

Required permissions:

ohos.permission.SET_PAC_URL

OH_NetConn_GetPacUrl()

NetConn_ErrorCode OH_NetConn_GetPacUrl(char *pacUrl)

Description

Obtains the URL of the system-level PAC script.

System capability: SystemCapability.Communication.NetManager.Core

Since: 15

Parameters

Name	Description
pacUrl	URL of the PAC script.

Returns

NETCONN_SUCCESS: success.

NETCONN_PERMISSION_DENIED: no permission.

NETCONN_OPERATION_FAILED: service connection failed.

NETCONN_INTERNAL_ERROR: internal error.

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Network Kit

harmony 鸿蒙NetConn_ConnectionProperties

harmony 鸿蒙NetConn_HttpProxy

harmony 鸿蒙NetConn_NetAddr

harmony 鸿蒙NetConn_NetCapabilities

harmony 鸿蒙NetConn_NetConnCallback

harmony 鸿蒙NetConn_NetHandle

harmony 鸿蒙NetConn_NetHandleList

harmony 鸿蒙NetConn_NetSpecifier

harmony 鸿蒙NetConn_Route