XDK API  3.6.0
Documentation
api Directory Reference
+ Directory dependency graph for api:

Files

file  Serval_Callable.h
 An implementation of function objects.This module implements a data structure Callable_T which encapsulates a function pointer. Callable_T elements are used as jobs which can be enqueued into the scheduler queue such that they are invoked when the scheduler processes its waiting queue. They are also used as callback functions in the case of asynchronous (non-blocking) calls, such as sending.
 
file  Serval_Coap.h
 Interface to CoAP (RFC 7253) constants and methodsThis module provides declarations which are commonly used by CoAP. This also provide the common interfaces provided by CoAP module e.g. interfaces to serialize or parse a CoAP message.
 
file  Serval_CoapClient.h
 CoAP Client ModuleThe interface description of the CoAP Client.
 
file  Serval_CoapServer.h
 CoAP Server ModuleThe interface description of the CoAP Server.
 
file  Serval_Defines.h
 Essential configurations of the library.
 
file  Serval_Dpws.h
 An interface to the DPWS component.The DPWS component implements the OASIS standard "Device Profile for Web Services" v1.1. (1. July 2009), see http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01.
 
file  Serval_Exceptions.h
 Serval ExceptionHandlingThis interface provides type definitions, data types and functions to handle exceptions.
 
file  Serval_Http.h
 Interface to HTTP constantsThis module provides declarations which are commonly used by HTTP.
 
file  Serval_HttpClient.h
 Interface for HTTP clientThis interface provides a function to send HTTP POST requests.
 
file  Serval_HttpServer.h
 HTTP Server ModuleThe interface description of the HTTP server.
 
file  Serval_Log.h
 Logging ModuleThis module provides function to handle the logging. The logging can be done via UART or UDP/IP. The logging can be done in different modes (e.g. debugging).
 
file  Serval_Lwm2m.h
 Interface to experimental lightweight M2M support.This module provides the interface to the implementation of the lightweight M2M protocol specified by the Open Mobile Alliance for machine to machine communication.
 
file  Serval_Mqtt.h
 Implementation of the MQTT protocol.
 
file  Serval_Msg.h
 An interface to the Messaging Module.This interface provides type definitions, data types and functions to handle messages.
 
file  Serval_Msg_Obsolete.h
 
file  Serval_Network.h
 Network helping moduleThis module provides some help functions to the stack with respect to IP and lower layers.
 
file  Serval_NVData.h
 It describes the struct for the non-volatile data data of the stack.In some applications, the device needs to periodically switch off and go to a deep-sleep state, where RAM and CPU registers are not retained. The stack supports such a duty-cycling mechanism by providing API functions to put the stack to sleep and to wake it up. In this case the stack must save its status into the non-volatile memory before going to sleep and to recover it when it wakes up again. This header specifies the non-volatile status of the stack in the struct NVData_S.
 
file  Serval_OpControl.h
 An interface to control the operation of stack.The header file provides functions to pre-initialize the stack components, which means, setting some essential flags to zero in the case this is not done by the boot loader. This must be done exactly once when the devices boots.
 
file  Serval_Policy.h
 Definition of backward compatibility.
 
file  Serval_Profiling.h
 Profiling ModuleThis module provides definitions and functions to support the task of runtime and energy profiling. Beside the functions for runtime measurement it sets the status of hardware pins in order to make certain activities visible and traceable using an oscilloscope or a logic analyzer.
 
file  Serval_Resources.h
 Lists the network sockets required by the stack.
 
file  Serval_Rest.h
 Interface to REST constants and methodsThis module provides declarations which are commonly used by REST. This also provides the common interfaces provided by REST module e.g. interfaces to parse a REST message.
 
file  Serval_RestClient.h
 REST Client ModuleThe interface description of the REST Client.
 
file  Serval_RestServer.h
 REST Server ModuleThe interface description of the REST Server.
 
file  Serval_Security.h
 Security configurations of the library.
 
file  Serval_Serializer.h
 Serializer ModuleThis interface provides functions for the serialization and de-serialization of various data type.
 
file  Serval_Sntp.h
 The interface description of an proprietary SNTP application protocol.
 
file  Serval_StopWatch.h
 An interface to the stop watch module.This file provides interfaces to use stop watch functionality. In addition to the data structures needed to represent and manage a stop watch, this file also includes the interfaces which provides functionality like starting a stop watch, getting absolute time in millisecond and second since the start of stop watch and also getting starting time of stop watch.
 
file  Serval_StringDescr.h
 This module defines a string descriptor type.This interface provides type definitions, data types and functions to handle string descriptors.
 
file  Serval_StructCtx.h
 Struct context moduleThis header provides the macro GET_CONTEXT_OF_MEMBER which calculates the address of a struct from a given struct member.
 
file  Serval_Types.h
 Serval data types definitions.
 
file  Serval_Url.h
 Functions to allow parsing a (limited) URL.
 
file  Serval_Uuid.h
 Uuid ModuleInterface providing data types and functions to handle UUIDs.
 
file  Serval_Version.h
 Interface to query the version of the communication stack.
 
file  Serval_Webserver.h
 Web Server ModuleThe application interface of the Webserver. In normal use cases the application does not need to directly access this interface. The "Web" component which added by the code generator to the application contains the glue code between the application stack and provides the application with a simplified interface.
 
file  Serval_Ws.h
 Interface to WebSocket (RFC 6455) methods.
 
file  Serval_WsClient.h
 Interface for WebSocket clientThis API has recently been added to the Stack and may be subject to change as feedback from usage is being obtained.
 
file  Serval_XmlParser.h
 Interface to XML ParserThe purpose of this module is scanning a XML document. This means that the characters are divided in logical (lexical) parts. All information needed to continue parsing is stored inside a context. That way it is possible to simultanously handle multiple SOAP requests. Every message gets its own context for scanning. Furthermore, the original XML document is not modified.
 
file  Serval_XTcp.h
 The interface description of a proprietary TCP based application protocol both for client and server.
 
file  Serval_XTcpClient.h
 The interface description of a proprietary TCP Client based application protocol.
 
file  Serval_XTcpServer.h
 The interface description of a proprietary TCP Server based application protocol.
 
file  Serval_XUdp.h
 The interface description of an proprietary UDP based application protocol.This UDP based application protocol enabled the application to push application specific data over UDP to some target receiver. The application data is assigned as raw message as well as the payload which is sent to the application by a communication partner. The length of the payload has to be provided by the application.
 

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:57 by doxygen 1.8.8