1 /* ****************************************************************
3 * Copyright 2014 Samsung Electronics All Rights Reserved.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
19 ******************************************************************/
24 * @brief This file contains message functionality.
27 #ifndef __CA_MESSAGE_HANDLER_H_
28 #define __CA_MESSAGE_HANDLER_H_
39 * @brief Detaches control from the caller for sending unicast request
40 * @param endpoint [IN] endpoint information where the data has to be sent
41 * @param request [IN] request that needs to be sent
42 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
44 CAResult_t CADetachRequestMessage(const CARemoteEndpoint_t *endpoint,
45 const CARequestInfo_t *request);
48 * @brief Detaches control from the caller for sending multicast request
49 * @param endpoint [IN] endpoint information where the data has to be sent
50 * @param request [IN] request that needs to be sent
51 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
53 CAResult_t CADetachRequestToAllMessage(const CAGroupEndpoint_t *object,
54 const CARequestInfo_t *request);
57 * @brief Detaches control from the caller for sending response
58 * @param endpoint [IN] endpoint information where the data has to be sent
59 * @param response [IN] request that needs to be sent
60 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
62 CAResult_t CADetachResponseMessage(const CARemoteEndpoint_t *endpoint,
63 const CAResponseInfo_t *response);
66 * @brief Detaches control from the caller for sending request
67 * @param resourceUri [IN] resource uri that needs to be sent in the request
68 * @param token [IN] token information of the request
69 * @param options [IN] header options that need to be append in the request
70 * @param numOptions [IN] number of options be appended
71 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
73 CAResult_t CADetachMessageResourceUri(const CAURI_t resourceUri, const CAToken_t token,
74 const CAHeaderOption_t *options, const uint8_t numOptions);
77 * @brief Setting the request and response callbacks for network packets
78 * @param ReqHandler [IN] callback for receiving the requests
79 * @param RespHandler [IN] callback for receiving the response
82 void CASetRequestResponseCallbacks(CARequestCallback ReqHandler,
83 CAResponseCallback RespHandler);
86 * @brief Initialize the message handler by starting thread pool and initializing the send and reive queue
87 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
89 CAResult_t CAInitializeMessageHandler();
92 * @brief Terminate the message handler by stopping the thread pool and destroying the queues
93 * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
95 void CATerminateMessageHandler();
98 * @brief Handler for receiving request and response callback in singled thread model
100 void CAHandleRequestResponseCallbacks();
106 #endif //#ifndef __CA_MESSAGE_HANDLER_H_