NetApp

Activates networking applications, such as: HTTP Server, DHCP Server, Ping, DNS and mDNS. More...

Functions
_i16	sl_NetAppStart (const _u32 AppBitMap)
	Starts a network application. More...
_i16	sl_NetAppStop (const _u32 AppBitMap)
	Stops a network application. More...
_i16	sl_NetAppDnsGetHostByName (_i8 *pHostName, const _u16 NameLen, _u32 *OutIpAddr, const _u8 Family)
	Get host IP by name Obtain the IP Address of machine on network, by machine name. More...
_i16	sl_NetAppDnsGetHostByService (_i8 *pServiceName, const _u8 ServiceLen, const _u8 Family, _u32 pAddr[], _u32 *pPort, _u16 *pTextLen, _i8 *pText)
	Return service attributes like IP address, port and text according to service name The user sets a service name Full/Part (see example below), and should get: More...
_i16	sl_NetAppGetServiceList (const _u8 IndexOffset, const _u8 MaxServiceCount, const _u8 Flags, _i8 *pBuffer, const _u32 BufferLength)
	Get service list Insert into out pBuffer a list of peer's services that are in the NWP without issuing any queries (relying on pervious collected data). The list is in a form of service struct. The user should chose the type of the service struct like: More...
_i16	sl_NetAppMDNSUnRegisterService (const _i8 *pServiceName, const _u8 ServiceNameLen, _u32 Options)
	Unregister mDNS service This function deletes the mDNS service from the mDNS package and the database. More...
_i16	sl_NetAppMDNSRegisterService (const _i8 *pServiceName, const _u8 ServiceNameLen, const _i8 *pText, const _u8 TextLen, const _u16 Port, const _u32 TTL, _u32 Options)
	Register a new mDNS service This function registers a new mDNS service to the mDNS package and the DB. This registered service is a service offered by the application. The service name should be full service name according to RFC of the DNS-SD - meaning the value in name field in the SRV answer. Example for service name: More...
_i16	sl_NetAppPing (const SlNetAppPingCommand_t *pPingParams, const _u8 Family, SlNetAppPingReport_t *pReport, const P_SL_DEV_PING_CALLBACK pPingCallback)
	send ICMP ECHO_REQUEST to network hosts More...
_i16	sl_NetAppSet (const _u8 AppId, const _u8 Option, const _u8 OptionLen, const _u8 *pOptionValue)
	Setting network application configurations. More...
_i16	sl_NetAppGet (const _u8 AppId, const _u8 Option, _u8 *pOptionLen, _u8 *pOptionValue)
	Getting network applications configurations. More...
_u16	sl_NetAppSend (_u16 Handle, _u16 DataLen, _u8 *pData, _u32 Flags)
	Function for sending Netapp response or data following a Netapp request event (i.e. HTTP GET request) More...
_SlReturnVal_t	sl_NetAppRecv (_u16 Handle, _u16 *DataLen, _u8 *pData, _u32 *Flags)
	Function for retrieving data from the network processor following a Netapp request event (i.e. HTTP POST request) More...

Typedefs
typedef void(*	P_SL_DEV_PING_CALLBACK) (SlNetAppPingReport_t *)

Enumerations
enum	SlNetAppEventId_e {   SL_NETAPP_EVENT_IPV4_ACQUIRED = 1,   SL_NETAPP_EVENT_IPV6_ACQUIRED,   SL_NETAPP_EVENT_IP_COLLISION,   SL_NETAPP_EVENT_DHCPV4_LEASED,   SL_NETAPP_EVENT_DHCPV4_RELEASED,   SL_NETAPP_EVENT_HTTP_TOKEN_GET,   SL_NETAPP_EVENT_HTTP_TOKEN_POST,   SL_NETAPP_EVENT_IPV4_LOST,   SL_NETAPP_EVENT_DHCP_IPV4_ACQUIRE_TIMEOUT,   SL_NETAPP_EVENT_IPV6_LOST,   SL_NETAPP_EVENT_MAX }
enum	SlIpV6AcquiredAsyncType_e {   SL_BSD_IPV6_ACQUIRED_TYPE_LOCAL = 1,   SL_BSD_IPV6_ACQUIRED_TYPE_GLOBAL = 2 }
enum	SlNetAppMetadataHTTPTypes_e {   SL_NETAPP_REQUEST_METADATA_TYPE_STATUS = 0,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_VERSION,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_REQUEST_URI,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_QUERY_STRING,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_CONTENT_LEN,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_CONTENT_TYPE,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_LOCATION,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_SERVER,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_USER_AGENT,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_COOKIE,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_SET_COOKIE,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_UPGRADE,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_REFERER,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_ACCEPT,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_CONTENT_ENCODING,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_CONTENT_DISPOSITION,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_CONNECTION,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_ETAG,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_DATE,   SL_NETAPP_REQUEST_METADATA_TYPE_HEADER_HOST,   SL_NETAPP_REQUEST_METADATA_TYPE_ACCEPT_ENCODING,   SL_NETAPP_REQUEST_METADATA_TYPE_ACCEPT_LANGUAGE,   SL_NETAPP_REQUEST_METADATA_TYPE_CONTENT_LANGUAGE,   SL_NETAPP_REQUEST_METADATA_TYPE_ORIGIN,   SL_NETAPP_REQUEST_METADATA_TYPE_ORIGIN_CONTROL_ACCESS,   SL_NETAPP_REQUEST_METADATA_TYPE_HTTP_NONE }
enum	SlNetAppResponseCode_e {   SL_NETAPP_RESPONSE_NONE = 0,   SL_NETAPP_RESPONSE_PENDING = 1,   SL_NETAPP_HTTP_RESPONSE_101_SWITCHING_PROTOCOLS = 101,   SL_NETAPP_HTTP_RESPONSE_200_OK = 200,   SL_NETAPP_HTTP_RESPONSE_201_CREATED = 201,   SL_NETAPP_HTTP_RESPONSE_202_ACCEPTED = 202,   SL_NETAPP_HTTP_RESPONSE_204_OK_NO_CONTENT = 204,   SL_NETAPP_HTTP_RESPONSE_301_MOVED_PERMANENTLY = 301,   SL_NETAPP_HTTP_RESPONSE_302_MOVED_TEMPORARILY = 302,   SL_NETAPP_HTTP_RESPONSE_303_SEE_OTHER = 303,   SL_NETAPP_HTTP_RESPONSE_304_NOT_MODIFIED = 304,   SL_NETAPP_HTTP_RESPONSE_400_BAD_REQUEST = 400,   SL_NETAPP_HTTP_RESPONSE_403_FORBIDDEN = 403,   SL_NETAPP_HTTP_RESPONSE_404_NOT_FOUND = 404,   SL_NETAPP_HTTP_RESPONSE_405_METHOD_NOT_ALLOWED = 405,   SL_NETAPP_HTTP_RESPONSE_500_INTERNAL_SERVER_ERROR = 500,   SL_NETAPP_HTTP_RESPONSE_503_SERVICE_UNAVAILABLE = 503,   SL_NETAPP_HTTP_RESPONSE_504_GATEWAY_TIMEOUT = 504 }
enum	SlNetAppGetServiceListType_e {   SL_NETAPP_FULL_SERVICE_WITH_TEXT_IPV4_TYPE = 1,   SL_NETAPP_FULL_SERVICE_IPV4_TYPE,   SL_NETAPP_SHORT_SERVICE_IPV4_TYPE,   SL_NETAPP_FULL_SERVICE_WITH_TEXT_IPV6_TYPE,   SL_NETAPP_FULL_SERVICE_IPV6_TYPE,   SL_NETAPP_SHORT_SERVICE_IPV6_TYPE }

Detailed Description

Activates networking applications, such as: HTTP Server, DHCP Server, Ping, DNS and mDNS.

Function Documentation

_i16 sl_NetAppDnsGetHostByName	(	_i8 *	pHostName,
		const _u16	NameLen,
		_u32 *	OutIpAddr,
		const _u8	Family
	)

Get host IP by name
Obtain the IP Address of machine on network, by machine name.

Parameters

[in]	pHostName	Host name
[in]	NameLen	Name length
[out]	OutIpAddr	This parameter is filled in with host IP address. In case that host name is not resolved, out_ip_addr is zero.
[in]	Family	Protocol family

Returns

Zero on success, or negative on failure.
SL_POOL_IS_EMPTY may be return in case there are no resources in the system
In this case try again later or increase MAX_CONCURRENT_ACTIONS Possible DNS error codes:

• SL_NETAPP_DNS_QUERY_NO_RESPONSE
• SL_NETAPP_DNS_NO_SERVER
• SL_NETAPP_DNS_QUERY_FAILED
• SL_NETAPP_DNS_MALFORMED_PACKET
• SL_NETAPP_DNS_MISMATCHED_RESPONSE

See also

Note

Only one sl_NetAppDnsGetHostByName can be handled at a time.
Calling this API while the same command is called from another thread, may result in one of the two scenarios:

1. The command will wait (internal) until the previous command finish, and then be executed.
2. There are not enough resources and POOL_IS_EMPTY error will return.
   In this case, MAX_CONCURRENT_ACTIONS can be increased (result in memory increase) or try again later to issue the command.

Warning

In case an IP address in a string format is set as input, without any prefix (e.g. "1.2.3.4") the device will not try to access the DNS and it will return the input address on the 'out_ip_addr' field

Example

• Getting host by name:

  _u32 DestinationIP;
  _u32 AddrSize;
  _i16 SockId;
  SlSockAddrIn_t Addr;
  
  sl_NetAppDnsGetHostByName("www.google.com", strlen("www.google.com"), &DestinationIP,SL_AF_INET);
  
  Addr.sin_family = SL_AF_INET;
  Addr.sin_port = sl_Htons(80);
  Addr.sin_addr.s_addr = sl_Htonl(DestinationIP);
  AddrSize = sizeof(SlSockAddrIn_t);
  SockId = sl_Socket(SL_AF_INET,SL_SOCK_STREAM, 0);

_i16 sl_NetAppDnsGetHostByService	(	_i8 *	pServiceName,
		const _u8	ServiceLen,
		const _u8	Family,
		_u32	pAddr[],
		_u32 *	pPort,
		_u16 *	pTextLen,
		_i8 *	pText
	)

Return service attributes like IP address, port and text according to service name
The user sets a service name Full/Part (see example below), and should get:

• IP of service
• The port of service
• The text of service Hence it can make a connection to the specific service and use it. It is similar to sl_NetAppDnsGetHostByName method.
  It is done by a single shot ipv4 & ipv6 (if enabled) query with PTR type on the service name. The command that is sent is from constant parameters and variables parameters.

Parameters

[in]	pServiceName	Service name can be full or partial. Example for full service name: PC1._ipp._tcp.local PC2_server._ftp._tcp.local Example for partial service name: _ipp._tcp.local _ftp._tcp.local
[in]	ServiceLen	The length of the service name (in_pService).
[in]	Family	IPv4 or IPv6 (SL_AF_INET , SL_AF_INET6).
[out]	pAddr	Contains the IP address of the service.
[out]	pPort	Contains the port of the service.
[out]	pTextLen	Has 2 options. One as Input field and the other one as output: Input: Contains the max length of the text that the user wants to get. It means that if the text len of service is bigger that its value than the text is cut to inout_TextLen value. Output: Contain the length of the text that is returned. Can be full text or part of the text (see above).
[out]	pText	Contains the text of the service full or partial

Returns

Zero on success,
SL_POOL_IS_EMPTY may be return in case there are no resources in the system, In this case try again later or increase MAX_CONCURRENT_ACTIONS
In case No service is found error SL_NETAPP_DNS_NO_ANSWER will be returned

See also

sl_NetAppDnsGetHostByName

Note

The returns attributes belongs to the first service found. There may be other services with the same service name that will response to the query. The results of these responses are saved in the peer cache of the Device and should be read by another API.
Only one sl_NetAppDnsGetHostByService can be handled at a time.
Calling this API while the same command is called from another thread, may result in one of the two scenarios:

1. The command will wait (internal) until the previous command finish, and then be executed.
2. There are not enough resources and SL_POOL_IS_EMPTY error will return. In this case, MAX_CONCURRENT_ACTIONS can be increased (result in memory increase) or try again later to issue the command.

Warning

Text length can be 120 bytes only

_i16 sl_NetAppGet	(	const _u8	AppId,
		const _u8	Option,
		_u8 *	pOptionLen,
		_u8 *	pOptionValue
	)

Getting network applications configurations.

Parameters

[in]	AppId	Application id, could be one of the following: SL_NETAPP_HTTP_SERVER_ID SL_NETAPP_DHCP_SERVER_ID SL_NETAPP_DNS_SERVER_ID SL_NETAPP_DEVICE_ID SL_NETAPP_DNS_CLIENT_ID
[in]	Option	Get option, could be one of the following: SL_NETAPP_DHCP_SERVER_ID: SL_NETAPP_DHCP_SRV_BASIC_OPT SL_NETAPP_HTTP_SERVER_ID: SL_NETAPP_HTTP_PRIMARY_PORT_NUMBER SL_NETAPP_HTTP_AUTH_CHECK SL_NETAPP_HTTP_AUTH_NAME SL_NETAPP_HTTP_AUTH_PASSWORD SL_NETAPP_HTTP_AUTH_REALM SL_NETAPP_HTTP_ROM_PAGES_ACCESS SL_NETAPP_HTTP_SECONDARY_PORT_NUMBER SL_NETAPP_HTTP_SECONDARY_PORT_ENABLE SL_NETAPP_HTTP_PRIMARY_PORT_SECURITY_MODE SL_NETAPP_MDNS_ID: SL_NETAPP_MDNS_CONT_QUERY_OPT SL_NETAPP_MDNS_QEVETN_MASK_OPT SL_NETAPP_MDNS_TIMING_PARAMS_OPT SL_NETAPP_DEVICE_ID: SL_NETAPP_DEVICE_URN SL_NETAPP_DEVICE_DOMAIN SL_NETAPP_DNS_CLIENT_ID: SL_NETAPP_DNS_CLIENT_TIME
[in]	pOptionLen	The length of the allocated memory as input, when the function complete, the value of this parameter would be the len that actually read from the device. If the device return length that is longer from the input value, the function will cut the end of the returned structure and will return ESMALLBUF
[out]	pOptionValue	pointer to the option structure which will be filled with the response from the device

Returns

Zero on success, or negative value if an error occurred.

See also

sl_NetAppSet

Note

Warning

Example

• Getting DHCP Server parameters example:

  SlNetAppDhcpServerBasicOpt_t dhcpParams;
  _u8 outLen = sizeof(SlNetAppDhcpServerBasicOpt_t);
  sl_NetAppGet(SL_NETAPP_DHCP_SERVER_ID, SL_NETAPP_SET_DHCP_SRV_BASIC_OPT, &outLen, (_u8* )&dhcpParams);
  
  printf("DHCP Start IP %d.%d.%d.%d End IP %d.%d.%d.%d Lease time seconds %d\n",                                                           
     SL_IPV4_BYTE(dhcpParams.ipv4_addr_start,3),SL_IPV4_BYTE(dhcpParams.ipv4_addr_start,2),
     SL_IPV4_BYTE(dhcpParams.ipv4_addr_start,1),SL_IPV4_BYTE(dhcpParams.ipv4_addr_start,0), 
     SL_IPV4_BYTE(dhcpParams.ipv4_addr_last,3),SL_IPV4_BYTE(dhcpParams.ipv4_addr_last,2),
     SL_IPV4_BYTE(dhcpParams.ipv4_addr_last,1),SL_IPV4_BYTE(dhcpParams.ipv4_addr_last,0),         
     dhcpParams.lease_time);    

  
  
• Getting device URN name:
  Maximum length of 32 characters of device name. Device name affects URN name, own SSID name in AP mode, and WPS file "device name" in WPS I.E (STA-WPS / P2P) in case no device URN name set, the default name is "mysimplelink"

  _u8 my_device_name[SL_NETAPP_MAX_DEVICE_URN_LEN];
  sl_NetAppGet (SL_NETAPP_DEVICE_ID, SL_NETAPP_DEVICE_URN, strlen(my_device_name), (_u8 *)my_device_name); 

  
  
• Getting DNS client time:
  Get DNS client (sl_NetAppDnsGetHostByName) timeout, two parameters max_response_time and number_retries. number_retries: Max number of DNS request before sl_NetAppDnsGetHostByName failed. max_response_time: DNS request timeout changed every retry, it`s start with 100 millisecond and increased every retry up to max_response_time milliseconds

  SlNetAppDnsClientTime_t time;
  _u8 pOptionLen  = sizeof(time);
  sl_NetAppGet (SL_NETAPP_DNS_CLIENT_ID, SL_NETAPP_DNS_CLIENT_TIME, &pOptionLen, (_u8 *)&time); 

  
  
• Getting active applications:
  Get active applications for active role. return value is mask of the active application (similar defines as sl_NetAppStart):

  _u32 AppBitMap;
  _u8 pOptionLen  = sizeof(AppBitMap);
  sl_NetAppGet (SL_NETAPP_STATUS, SL_NETAPP_STATUS_ACTIVE_APP, &pOptionLen, (_u8 *)&AppBitMap); 

_i16 sl_NetAppGetServiceList	(	const _u8	IndexOffset,
		const _u8	MaxServiceCount,
		const _u8	Flags,
		_i8 *	pBuffer,
		const _u32	BufferLength
	)

Get service list
Insert into out pBuffer a list of peer's services that are in the NWP without issuing any queries (relying on pervious collected data).
The list is in a form of service struct. The user should chose the type of the service struct like:

• Full service parameters with text.
• Full service parameters.
• Short service parameters (port and IP only) especially for tiny hosts.

The different types of struct are made to give the possibility to save memory in the host.
The user can also chose how many max services to get and start point index NWP peer cache.
For example:

1. Get max of 3 full services from index 0.
   • Up to 3 full services from index 0 are inserted into pBuffer (services that are in indexes 0,1,2).
2. Get max of 4 full services from index 3.
   • Up to 4 full services from index 3 are inserted into pBuffer (services that are in indexes 3,4,5,6).
3. Get max of 2 int services from index 6.
   • Up to 2 int services from index 6 are inserted into pBuffer (services that are in indexes 6,7). See below - command parameters.

Parameters

[in]	IndexOffset	- The start index in the peer cache that from it the first service is returned.
[in]	MaxServiceCount	- The Max services that can be returned if existed or if not exceed the max index in the peer cache
[in]	Flags	- an ENUM number that means which service struct to use (means which types of service to fill) use SL_NETAPP_FULL_SERVICE_WITH_TEXT_IPV4_TYPE for SlNetAppGetFullServiceWithTextIpv4List_t use SL_NETAPP_FULL_SERVICE_IPV4_TYPE for SlNetAppGetFullServiceIpv4List_t use SL_NETAPP_SHORT_SERVICE_IPV4_TYP SlNetAppGetShortServiceIpv4List_t use SL_NETAPP_FULL_SERVICE_IPV6_TYPE, SlNetAppGetFullServiceIpv6List_t use SL_NETAPP_SHORT_SERVICE_IPV6_TYPE SlNetAppGetShortServiceIpv6List_t use SL_NETAPP_FULL_SERVICE_WITH_TEXT_IPV6_TYPE SlNetAppGetFullServiceWithTextIpv6List_t
[out]	pBuffer	- The Services are inserted into this buffer. In the struct form according to the bit that is set in the Flags input parameter.
[in]	BufferLength	- The allocated buffer length (pointed by pBuffer).

Returns

ServiceFoundCount - The number of the services that were inserted into the buffer.
Zero means no service is found negative number means an error

See also

sl_NetAppMDNSRegisterService

Note

Warning

If the out pBuffer size is bigger than an RX packet(1480), than an error is returned because there is no place in the RX packet.
The size is a multiply of MaxServiceCount and size of service struct(that is set according to flag value).

_i16 sl_NetAppMDNSRegisterService	(	const _i8 *	pServiceName,
		const _u8	ServiceNameLen,
		const _i8 *	pText,
		const _u8	TextLen,
		const _u16	Port,
		const _u32	TTL,
		_u32	Options
	)

Register a new mDNS service
This function registers a new mDNS service to the mDNS package and the DB.
This registered service is a service offered by the application. The service name should be full service name according to RFC of the DNS-SD - meaning the value in name field in the SRV answer.
Example for service name:

1. PC1._ipp._tcp.local
2. PC2_server._ftp._tcp.local

If the option is_unique is set, mDNS probes the service name to make sure it is unique before starting to announce the service on the network. Instance is the instance portion of the service name.

Parameters

[in]	ServiceNameLen	The length of the service.
[in]	TextLen	The length of the service should be smaller than 64.
[in]	Port	The port on this target host port.
[in]	TTL	The TTL of the service
[in]	Options	bitwise parameters: SL_NETAPP_MDNS_OPTIONS_IS_UNIQUE_BIT bit 0 - service is unique per interface (means that the service needs to be unique) SL_NETAPP_MDNS_IPV6_IPV4_SERVICE bit 27 - add this service to IPv6 interface, if exist (default is IPv4 service only) SL_NETAPP_MDNS_IPV6_ONLY_SERVICE bit 28 - add this service to IPv6 interface, but remove it from IPv4 (only IPv6 is available) SL_NETAPP_MDNS_OPTION_UPDATE_TEXT bit 29 - for update text fields (without reregister the service) SL_NETAPP_MDNS_OPTIONS_IS_NOT_PERSISTENT bit 30 - for setting a non persistent service SL_NETAPP_MDNS_OPTIONS_ADD_SERVICE_BIT bit 31 - for internal use if the service should be added or deleted (set means ADD).
[in]	pServiceName	The service name.
[in]	pText	The description of the service. should be as mentioned in the RFC (according to type of the service IPP,FTP...)

Returns

Zero on success, or negative error code on failure

See also

sl_NetAppMDNSUnRegisterService

Warning

1) Temporary - there is an allocation on stack of internal buffer. Its size is SL_NETAPP_MDNS_MAX_SERVICE_NAME_AND_TEXT_LENGTH.
It means that the sum of the text length and service name length cannot be bigger than SL_NETAPP_MDNS_MAX_SERVICE_NAME_AND_TEXT_LENGTH.
If it is - An error is returned.
2) According to now from certain constraints the variables parameters are set in the attribute part (contain constant parameters)

Examples:

• Register a new service:

  const signed char AddService[40]            = "PC1._ipp._tcp.local";
  _u32  Options;
  
  Options = SL_NETAPP_MDNS_OPTIONS_IS_UNIQUE_BIT | SL_NETAPP_MDNS_OPTIONS_IS_NOT_PERSISTENT;
  sl_NetAppMDNSRegisterService(AddService,sizeof(AddService),"Service 1;payper=A3;size=5",strlen("Service 1;payper=A3;size=5"),1000,120,Options);

  
  
• Update text for existing service:

  Please Note! Update is for text only! Importent to apply the same persistent flag options as original service registration.\n
  
  Options = SL_NETAPP_MDNS_OPTION_UPDATE_TEXT | SL_NETAPP_MDNS_OPTIONS_IS_NOT_PERSISTENT;
  sl_NetAppMDNSRegisterService(AddService,sizeof(AddService),"Service 5;payper=A4;size=10",strlen("Service 5;payper=A4;size=10"),1000,120,Options);

_i16 sl_NetAppMDNSUnRegisterService	(	const _i8 *	pServiceName,
		const _u8	ServiceNameLen,
		_u32	Options
	)

Unregister mDNS service
This function deletes the mDNS service from the mDNS package and the database.

The mDNS service that is to be unregistered is a service that the application no longer wishes to provide.
The service name should be the full service name according to RFC of the DNS-SD - meaning the value in name field in the SRV answer.

Examples for service names:

1. PC1._ipp._tcp.local
2. PC2_server._ftp._tcp.local

Parameters

[in]	pServiceName	Full service name.
[in]	ServiceNameLen	The length of the service.
[in]	Options	bitwise parameters: SL_NETAPP_MDNS_OPTIONS_IS_UNIQUE_BIT bit 0 - service is unique per interface (means that the service needs to be unique) SL_NETAPP_MDNS_IPV6_IPV4_SERVICE bit 27 - add this service to IPv6 interface, if exist (default is IPv4 service only) SL_NETAPP_MDNS_IPV6_ONLY_SERVICE bit 28 - add this service to IPv6 interface, but remove it from IPv4 (only IPv6 is available) SL_NETAPP_MDNS_OPTION_UPDATE_TEXT bit 29 - for update text fields (without reregister the service) SL_NETAPP_MDNS_OPTIONS_IS_NOT_PERSISTENT bit 30 - for setting a non persistent service SL_NETAPP_MDNS_OPTIONS_ADD_SERVICE_BIT bit 31 - for internal use if the service should be added or deleted (set means ADD).

Returns

Zero on success, or negative error code on failure

See also

sl_NetAppMDNSRegisterService

Note

Warning

The size of the service length should be smaller than 255.

_i16 sl_NetAppPing	(	const SlNetAppPingCommand_t *	pPingParams,
		const _u8	Family,
		SlNetAppPingReport_t *	pReport,
		const P_SL_DEV_PING_CALLBACK	pPingCallback
	)

send ICMP ECHO_REQUEST to network hosts

Ping uses the ICMP protocol's mandatory ECHO_REQUEST

Parameters

[in]	pPingParams	Pointer to the ping request structure: If flags parameter is set to 0, ping will report back once all requested pings are done (as defined by TotalNumberOfAttempts). If flags parameter is set to 1, ping will report back after every ping, for TotalNumberOfAttempts. If flags parameter is set to 2, ping will stop after the first successful ping, and report back for the successful ping, as well as any preceding failed ones. If flags parameter is set to 4, for ipv4 - don`t fragment the ping packet. This flag can be set with other flags. For stopping an ongoing ping activity, set parameters IP address to 0
[in]	Family	SL_AF_INET or SL_AF_INET6
[out]	pReport	Ping pReport
[out]	pPingCallback	Callback function upon completion. If callback is NULL, the API is blocked until data arrives

Returns

Zero on success, or negative error code on failure.
SL_POOL_IS_EMPTY may be return in case there are no resources in the system In this case try again later or increase MAX_CONCURRENT_ACTIONS

See also

Note

Only one sl_NetAppPing can be handled at a time. Calling this API while the same command is called from another thread, may result in one of the two scenarios:

1. The command will wait (internal) until the previous command finish, and then be executed.
2. There are not enough resources and SL_POOL_IS_EMPTY error will return. In this case, MAX_CONCURRENT_ACTIONS can be increased (result in memory increase) or try again later to issue the command.

Warning

Example:

• Sending 20 ping requests and reporting results to a callback routine when all requests are sent:

  // callback routine
  void pingRes(SlNetAppPingReport_t* pReport)
  {
  // handle ping results 
  }
        
  // ping activation
  void PingTest()
  {
      SlNetAppPingReport_t report;
      SlNetAppPingCommand_t pingCommand;
           
      pingCommand.Ip = SL_IPV4_VAL(10,1,1,200);     // destination IP address is 10.1.1.200
      pingCommand.PingSize = 150;                   // size of ping, in bytes 
      pingCommand.PingIntervalTime = 100;           // delay between pings, in milliseconds
      pingCommand.PingRequestTimeout = 1000;        // timeout for every ping in milliseconds
      pingCommand.TotalNumberOfAttempts = 20;       // max number of ping requests. 0 - forever 
      pingCommand.Flags = 0;                        // report only when finished
  
      sl_NetAppPing( &pingCommand, SL_AF_INET, &report, pingRes ) ;
  }

  
  
• Stopping Ping command:

  Status = sl_NetAppPing(0, 0, 0, 0 ) ;

_SlReturnVal_t sl_NetAppRecv	(	_u16	Handle,
		_u16 *	DataLen,
		_u8 *	pData,
		_u32 *	Flags
	)

Function for retrieving data from the network processor following a Netapp request event (i.e. HTTP POST request)

Parameters

[in]	Handle	Handle to receive data from. Should match the handle received in the Netapp request event
[in,out]	*DataLen	Max buffer size (in) / Actual data received (out)
[out]	*pData	Data received
[in,out]	*Flags	Can have the following values: SL_NETAPP_REQUEST_RESPONSE_FLAGS_CONTINUATION (out) More data is pending in the network procesor. Application should continue reading the data by calling sl_NetAppRecv again

Returns

Zero on success, or negative error code on failure

See also

sl_NetAppSend

Note

Warning

handle is received in the sl_NetAppRequestHandler callback. Handle is valid untill all data is receive from the network processor.

_u16 sl_NetAppSend	(	_u16	Handle,
		_u16	DataLen,
		_u8 *	pData,
		_u32	Flags
	)

Function for sending Netapp response or data following a Netapp request event (i.e. HTTP GET request)

Parameters

[in]	Handle	Handle to send the data to. Should match the handle received in the Netapp request event
[in]	DataLen	Data Length
[in]	pData	Data to send. Can be just data payload or metadata (depends on flags)
[out]	Flags	Can have the following values: SL_NETAPP_REQUEST_RESPONSE_FLAGS_CONTINUATION - More data will arrive in subsequent calls to NetAppSend SL_NETAPP_REQUEST_RESPONSE_FLAGS_METADATA - 0 - data is payload, 1 - data is metadata SL_NETAPP_REQUEST_RESPONSE_FLAGS_ACCUMULATION - The network processor should accumulate the data chunks and will process it when it is completelly received

Returns

Zero on success, or negative error code on failure

See also

sl_NetAppRecv

Note

Warning

_i16 sl_NetAppSet	(	const _u8	AppId,
		const _u8	Option,
		const _u8	OptionLen,
		const _u8 *	pOptionValue
	)

Setting network application configurations.

Parameters

[in]	AppId	Application id, could be one of the following: SL_NETAPP_HTTP_SERVER_ID SL_NETAPP_DHCP_SERVER_ID (AP Role only) SL_NETAPP_MDNS_ID SL_NETAPP_DNS_SERVER_ID SL_NETAPP_DEVICE_ID SL_NETAPP_DNS_CLIENT_ID
[in]	Option	Set option, could be one of the following: For SL_NETAPP_HTTP_SERVER_ID SL_NETAPP_HTTP_PRIMARY_PORT_NUMBER SL_NETAPP_HTTP_AUTH_CHECK SL_NETAPP_HTTP_AUTH_NAME SL_NETAPP_HTTP_AUTH_PASSWORD SL_NETAPP_HTTP_AUTH_REALM SL_NETAPP_HTTP_ROM_PAGES_ACCESS SL_NETAPP_HTTP_SECONDARY_PORT_NUMBER SL_NETAPP_HTTP_SECONDARY_PORT_ENABLE SL_NETAPP_HTTP_PRIMARY_PORT_SECURITY_MODE SL_NETAPP_HTTP_PRIVATE_KEY_FILENAME SL_NETAPP_HTTP_DEVICE_CERTIFICATE_FILENAME SL_NETAPP_HTTP_CA_CERTIFICATE_FILE_NAME SL_NETAPP_HTTP_TEMP_REGISTER_MDNS_SERVICE_NAME SL_NETAPP_HTTP_TEMP_UNREGISTER_MDNS_SERVICE_NAME For SL_NETAPP_DHCP_SERVER_ID: SL_NETAPP_DHCP_SERVER_BASIC_OPT For SL_NETAPP_MDNS_ID: SL_NETAPP_MDNS_CONT_QUERY_OPT SL_NETAPP_MDNS_QEVETN_MASK_OPT SL_NETAPP_MDNS_TIMING_PARAMS_OPT For SL_NETAPP_DEVICE_ID: SL_NETAPP_DEVICE_URN SL_NETAPP_DEVICE_DOMAIN For SL_NETAPP_DNS_CLIENT_ID: SL_NETAPP_DNS_CLIENT_TIME
[in]	OptionLen	Option structure length
[in]	pOptionValue	Pointer to the option structure

Persistent

Reset:

• SL_NETAPP_DHCP_SERVER_BASIC_OPT
  

Non- Persistent:

• SL_NETAPP_HTTP_TEMP_REGISTER_MDNS_SERVICE_NAME
• SL_NETAPP_HTTP_TEMP_UNREGISTER_MDNS_SERVICE_NAME
  

System Persistent:

• SL_NETAPP_HTTP_PRIMARY_PORT_NUMBER
• SL_NETAPP_HTTP_AUTH_CHECK
• SL_NETAPP_HTTP_AUTH_NAME
• SL_NETAPP_HTTP_AUTH_PASSWORD
• SL_NETAPP_HTTP_AUTH_REALM
• SL_NETAPP_HTTP_ROM_PAGES_ACCESS
• SL_NETAPP_HTTP_SECONDARY_PORT_NUMBER
• SL_NETAPP_HTTP_SECONDARY_PORT_ENABLE
• SL_NETAPP_HTTP_PRIMARY_PORT_SECURITY_MODE
• SL_NETAPP_HTTP_PRIVATE_KEY_FILENAME
• SL_NETAPP_HTTP_DEVICE_CERTIFICATE_FILE_NAME
• SL_NETAPP_HTTP_CA_CERTIFICATE_FILENAME
• SL_NETAPP_MDNS_CONT_QUERY_OPT
• SL_NETAPP_MDNS_QEVETN_MASK_OPT
• SL_NETAPP_MDNS_TIMING_PARAMS_OPT
• SL_NETAPP_DEV_CONF_OPT_DEVICE_URN
• SL_NETAPP_DEV_CONF_OPT_DOMAIN_NAME

Returns

Zero on success, or negative value if an error occurred.

See also

sl_NetAppGet

Note

Warning

Example

• Setting DHCP Server (AP mode) parameters example:

  SlNetAppDhcpServerBasicOpt_t dhcpParams; 
  _u8 outLen = sizeof(SlNetAppDhcpServerBasicOpt_t); 
  dhcpParams.lease_time      = 4096;                         // lease time (in seconds) of the IP Address
  dhcpParams.ipv4_addr_start =  SL_IPV4_VAL(192,168,1,10);   // first IP Address for allocation. IP Address should be set as Hex number - i.e. 0A0B0C01 for (10.11.12.1)
  dhcpParams.ipv4_addr_last  =  SL_IPV4_VAL(192,168,1,16);   // last IP Address for allocation. IP Address should be set as Hex number - i.e. 0A0B0C01 for (10.11.12.1)
  sl_NetAppStop(SL_NETAPP_DHCP_SERVER_ID);                  // Stop DHCP server before settings
  sl_NetAppSet(SL_NETAPP_DHCP_SERVER_ID, SL_NETAPP_DHCP_SRV_BASIC_OPT, outLen, (_u8* )&dhcpParams);  // set parameters
  sl_NetAppStart(SL_NETAPP_DHCP_SERVER_ID);                 // Start DHCP server with new settings

  
  
• Setting Device URN name:
  Device name, maximum length of 32 characters Device name affects URN name, and WPS file "device name" in WPS I.E (STA-WPS / P2P) In case no device URN name set, the default name is "mysimplelink" In case of setting the device name with length 0, device will return to default name "mysimplelink" Allowed characters in device name are: 'a - z' , 'A - Z' , '0-9' and '-'

  _u8 *my_device = "MY-SIMPLELINK-DEV";
  sl_NetAppSet (SL_NETAPP_DEVICE_ID, SL_NETAPP_DEVICE_URN, strlen(my_device), (_u8 *) my_device);

  
  
• Register new temporary HTTP service name for MDNS (not persistent):

  _u8 *my_http_temp_name = "New - Bonjour Service Name";
  sl_NetAppSet (SL_NETAPP_HTTP_SERVER_ID, SL_NETAPP_HTTP_TEMP_REGISTER_MDNS_SERVICE_NAME, strlen(my_http_temp_name), (_u8 *) my_http_temp_name); 

  
  
• Remove registration of current HTTP internal MDNS service (not persistent) :

  _u8 *old_http_name  = "0800285A7891@mysimplelink-022";
  sl_NetAppSet (SL_NETAPP_HTTP_SERVER_ID, SL_NETAPP_HTTP_TEMP_UNREGISTER_MDNS_SERVICE_NAME, strlen(old_http_name), (_u8 *) old_http_name); 

  
  
• Set DNS client time example:
  Set DNS client (sl_NetAppDnsGetHostByName) timeout, two parameters max_response_time and number_retries. number_retries: Max number of DNS request before sl_NetAppDnsGetHostByName failed, (up to 100 retries). max_response_time: DNS request timeout changed every retry, it`s start with 100 millisecond and increased every retry up to max_response_time milliseconds, (up to 2 seconds)

  SlNetAppDnsClientTime_t time;
  time.MaxResponseTime = 2000;
  time.NumOfRetries = 30;
  sl_NetAppSet (SL_NETAPP_DNS_CLIENT_ID, SL_NETAPP_DNS_CLIENT_TIME, sizeof(time), (_u8 *)&time); 

  
  
• Start MDNS continuous querys:
  In a continuous mDNS query mode, the device keeps sending queries to the network according to a specific service name. The query will be sent in IPv4 and IPv6 (if enabled) format. To see the completed list of responding services sl_NetAppGetServiceList() need to be called

  const signed char AddService[40]            = "Printer._ipp._tcp.local";
  _i16 Status;
  
  Status = sl_NetAppSet(SL_NETAPP_MDNS_ID, SL_NETAPP_MDNS_CONT_QUERY_OPT,strlen(AddService) , &AddService);

  
  
• Stop MDNS:

  Status = sl_NetAppSet(SL_NETAPP_MDNS_ID, SL_NETAPP_MDNS_CONT_QUERY_OPT,0 , 0);

  
  
• Set MDNS timing parameters for service advertisement:
  This option allows to control and reconfigures the timing parameters for service advertisement

  SlNetAppServiceAdvertiseTimingParameters_t Timing;
  _i16 Status;
  
  Timing.t = 200; // 2 seconds
  Timing.p = 2; // 2 repetitions
  Timing.k = 2; // Telescopic factor 2
  Timing.RetransInterval = 0; 
  Timing.Maxinterval = 0xFFFFFFFF;
  Timing.max_time = 5;
  
  Status = sl_NetAppSet(SL_NETAPP_MDNS_ID, SL_NETAPP_MDNS_TIMING_PARAMS_OPT,sizeof(Timing),&Timing);

  
  
• User-defined service types to monitor:
  In cases that the user decides not to get responses from certain types of services it should set the adapt bit in the event mask that is related to:

  // bit 0:  _ipp  
  // bit 1:  _device-info 
  // bit 2:  _http
  // bit 3:  _https
  // bit 4:  _workstation
  // bit 5:  _guid
  // bit 6:  _h323
  // bit 7:  _ntp
  // bit 8:  _objective
  // bit 9:  _rdp
  // bit 10: _remote
  // bit 11: _rtsp
  // bit 12: _sip
  // bit 13: _smb
  // bit 14: _soap
  // bit 15: _ssh
  // bit 16: _telnet
  // bit 17: _tftp
  // bit 18: _xmpp-client
  // bit 19: _raop
  
  
  _u32 EventMask;
  _i16 Status;
  
  EventMask = BIT0 | BIT1 | BIT18;
  Status = sl_NetAppSet(SL_NETAPP_MDNS_ID, SL_NETAPP_MDNS_QEVETN_MASK_OPT,sizeof(EventMask),&EventMask)

  
  

_i16 sl_NetAppStart

(

const _u32

AppBitMap

)

Starts a network application.

Gets and starts network application for the current WLAN mode

Parameters

[in]

AppBitMap

Application bitmap, could be one or combination of the following: SL_NETAPP_HTTP_SERVER_ID SL_NETAPP_DHCP_SERVER_ID SL_NETAPP_MDNS_ID SL_NETAPP_DNS_SERVER_ID

Persistent - System Persistent

Returns

Zero on success, or negative error code on failure

See also

sl_NetAppStop

Note

This command activates the application for the current WLAN mode (AP or STA)

Warning

Example

• Starting internal HTTP server + DHCP server:

  sl_NetAppStart(SL_NETAPP_HTTP_SERVER_ID | SL_NETAPP_DHCP_SERVER_ID)

_i16 sl_NetAppStop

(

const _u32

AppBitMap

)

Stops a network application.

Gets and stops network application for the current WLAN mode

Parameters

[in]

AppBitMap

Application id, could be one of the following: SL_NETAPP_HTTP_SERVER_ID SL_NETAPP_DHCP_SERVER_ID SL_NETAPP_MDNS_ID SL_NETAPP_DNS_SERVER_ID

Persistent - System Persistent

Returns

Zero on success, or nagative error code on failure

See also

sl_NetAppStart

Note

This command disables the application for the current active WLAN mode (AP or STA)

Warning

Example

• Stopping internal HTTP server:

  sl_NetAppStop(SL_NETAPP_HTTP_SERVER_ID); 

---

Data Structure Documentation

struct SlIpV4AcquiredAsync_t

Definition at line 187 of file netapp.h.

Data Fields
_u32	Dns
_u32	Gateway
_u32	Ip

struct SlIpV6AcquiredAsync_t

Definition at line 201 of file netapp.h.

Data Fields
_u32	Dns[4]
_u32	Ip[4]

struct SlIpLeasedAsync_t

Definition at line 207 of file netapp.h.

Data Fields
_u32	IpAddress
_u32	LeaseTime
_u8	Mac[6]
_u16	Padding

struct SlIpReleasedAsync_t

Definition at line 215 of file netapp.h.

Data Fields
_u32	IpAddress
_u8	Mac[6]
_u16	Reason

struct SlIpCollisionAsync_t

Definition at line 222 of file netapp.h.

Data Fields
_u8	ConflictMac[6]
_u8	DhcpMac[6]
_u32	IpAddress

struct SlIpV4Lost_t

Definition at line 229 of file netapp.h.

Data Fields
_u16	Padding
_i16	Status

struct SlIpV6Lost_t

Definition at line 235 of file netapp.h.

Data Fields
_u32	IpLost[4]

struct SlDhcpIpAcquireTimeout_t

Definition at line 240 of file netapp.h.

Data Fields
_u16	Padding
_i16	Status

union SlNetAppEventData_u

Definition at line 247 of file netapp.h.

Data Fields
SlDhcpIpAcquireTimeout_t	DhcpIpAcquireTimeout
SlIpV4AcquiredAsync_t	IpAcquiredV4
SlIpV6AcquiredAsync_t	IpAcquiredV6
SlIpCollisionAsync_t	IpCollision
SlIpLeasedAsync_t	IpLeased
SlIpReleasedAsync_t	IpReleased
SlIpV4Lost_t	IpV4Lost
SlIpV6Lost_t	IpV6Lost
_u32	Sd

struct SlNetAppEvent_t

Definition at line 260 of file netapp.h.

Data Fields
SlNetAppEventData_u	Data
_u32	Id

struct SlNetAppPingReport_t

Definition at line 267 of file netapp.h.

Data Fields
_u16	AvgRoundTime
_u16	MaxRoundTime
_u16	MinRoundTime
_u32	PacketsReceived
_u32	PacketsSent
_u32	TestTime

struct SlNetAppPingCommand_t

Definition at line 277 of file netapp.h.

Data Fields
_u32	Flags
_u32	Ip
_u32	Ip1OrPadding
_u32	Ip2OrPadding
_u32	Ip3OrPadding
_u32	PingIntervalTime
_u16	PingRequestTimeout
_u16	PingSize
_u32	TotalNumberOfAttempts

struct SlNetAppHttpServerString_t

Definition at line 290 of file netapp.h.

Data Fields
_u8	Len
_u8 *	pData

struct SlNetAppHttpServerData_t

Definition at line 296 of file netapp.h.

Data Fields
_u8	NameLen
_u8 *	pTokenName
_u8 *	pTokenValue
_u8	ValueLen

struct SlNetAppHttpServerPostData_t

Definition at line 304 of file netapp.h.

Data Fields
SlNetAppHttpServerString_t	Action
SlNetAppHttpServerString_t	TokenName
SlNetAppHttpServerString_t	TokenValue

union SlNetAppHttpServerEventData_u

Definition at line 311 of file netapp.h.

Data Fields
SlNetAppHttpServerPostData_t	HttpPostData
SlNetAppHttpServerString_t	HttpTokenName

union SlNetAppHttpServerResponsedata_u

Definition at line 317 of file netapp.h.

Data Fields
SlNetAppHttpServerString_t	TokenValue

struct SlNetAppHttpServerEvent_t

Definition at line 322 of file netapp.h.

Data Fields
_u32	Event
SlNetAppHttpServerEventData_u	EventData

struct SlNetAppHttpServerResponse_t

Definition at line 328 of file netapp.h.

Data Fields
_u32	Response
SlNetAppHttpServerResponsedata_u	ResponseData

struct SlNetAppData_t

Definition at line 408 of file netapp.h.

Data Fields
_u32	Flags
_u16	MetadataLen
_u16	PayloadLen
_u8 *	pMetadata
_u8 *	pPayload

struct SlNetAppRequest_t

Definition at line 417 of file netapp.h.

Data Fields
_u8	AppId
_u16	Handle
SlNetAppData_t	requestData
_u8	Type

struct SlNetAppResponse_t

Definition at line 426 of file netapp.h.

Data Fields
SlNetAppData_t	ResponseData
_u16	Status

struct SlNetAppDhcpServerBasicOpt_t

Definition at line 434 of file netapp.h.

Data Fields
_u32	ipv4_addr_last
_u32	ipv4_addr_start
_u32	lease_time

struct SlNetAppGetShortServiceIpv4List_t

Definition at line 452 of file netapp.h.

Data Fields
_u16	Reserved
_u32	service_ipv4
_u16	service_port

struct SlNetAppGetFullServiceIpv4List_t

Definition at line 459 of file netapp.h.

Data Fields
_u16	Reserved
_u8	service_host[SL_NETAPP_MAX_SERVICE_HOST_NAME_SIZE]
_u32	service_ipv4
_u8	service_name[SL_NETAPP_MAX_SERVICE_NAME_SIZE]
_u16	service_port

struct SlNetAppGetFullServiceWithTextIpv4List_t

Definition at line 468 of file netapp.h.

Data Fields
_u16	Reserved
_u8	service_host[SL_NETAPP_MAX_SERVICE_HOST_NAME_SIZE]
_u32	service_ipv4
_u8	service_name[SL_NETAPP_MAX_SERVICE_NAME_SIZE]
_u16	service_port
_u8	service_text[SL_NETAPP_MAX_SERVICE_TEXT_SIZE]

struct SlNetAppGetShortServiceIpv6List_t

Definition at line 479 of file netapp.h.

Data Fields
_u16	Reserved
_u32	service_ipv6[4]
_u16	service_port

struct SlNetAppGetFullServiceIpv6List_t

Definition at line 486 of file netapp.h.

Data Fields
_u16	Reserved
_u8	service_host[SL_NETAPP_MAX_SERVICE_HOST_NAME_SIZE]
_u32	service_ipv6[4]
_u8	service_name[SL_NETAPP_MAX_SERVICE_NAME_SIZE]
_u16	service_port

struct SlNetAppGetFullServiceWithTextIpv6List_t

Definition at line 495 of file netapp.h.

Data Fields
_u16	Reserved
_u8	service_host[SL_NETAPP_MAX_SERVICE_HOST_NAME_SIZE]
_u32	service_ipv6[4]
_u8	service_name[SL_NETAPP_MAX_SERVICE_NAME_SIZE]
_u16	service_port
_u8	service_text[SL_NETAPP_MAX_SERVICE_TEXT_SIZE]

struct SlNetAppServiceAdvertiseTimingParameters_t

Definition at line 506 of file netapp.h.

Data Fields
_u32	k
_u32	max_time
_u32	Maxinterval
_u32	p
_u32	RetransInterval
_u32	t

struct SlNetAppDnsClientTime_t

Definition at line 531 of file netapp.h.

Data Fields
_u16	MaxResponseTime
_u16	NumOfRetries