Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/netsocket/ControlPlane_netif.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 1:9db0e321a9f4 1 /*
kenjiArai 1:9db0e321a9f4 2 * Copyright (c) 2018, Arm Limited and affiliates.
kenjiArai 1:9db0e321a9f4 3 * SPDX-License-Identifier: Apache-2.0
kenjiArai 1:9db0e321a9f4 4 *
kenjiArai 1:9db0e321a9f4 5 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 1:9db0e321a9f4 6 * you may not use this file except in compliance with the License.
kenjiArai 1:9db0e321a9f4 7 * You may obtain a copy of the License at
kenjiArai 1:9db0e321a9f4 8 *
kenjiArai 1:9db0e321a9f4 9 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 1:9db0e321a9f4 10 *
kenjiArai 1:9db0e321a9f4 11 * Unless required by applicable law or agreed to in writing, software
kenjiArai 1:9db0e321a9f4 12 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 1:9db0e321a9f4 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 1:9db0e321a9f4 14 * See the License for the specific language governing permissions and
kenjiArai 1:9db0e321a9f4 15 * limitations under the License.
kenjiArai 1:9db0e321a9f4 16 */
kenjiArai 1:9db0e321a9f4 17 #ifndef CONTROLPLANE_NETIF_H_
kenjiArai 1:9db0e321a9f4 18 #define CONTROLPLANE_NETIF_H_
kenjiArai 1:9db0e321a9f4 19
kenjiArai 1:9db0e321a9f4 20 #include "nsapi_types.h"
kenjiArai 1:9db0e321a9f4 21
kenjiArai 1:9db0e321a9f4 22 /** @file ControlPlane_netif.h
kenjiArai 1:9db0e321a9f4 23 * @brief Implements support for data transfer using Control Plane CIoT EPS optimization.
kenjiArai 1:9db0e321a9f4 24 *
kenjiArai 1:9db0e321a9f4 25 */
kenjiArai 1:9db0e321a9f4 26
kenjiArai 1:9db0e321a9f4 27 namespace mbed {
kenjiArai 1:9db0e321a9f4 28
kenjiArai 1:9db0e321a9f4 29 /* Length of the buffer storing data received over control plane */
kenjiArai 1:9db0e321a9f4 30 #ifndef MBED_CONF_CELLULAR_MAX_CP_DATA_RECV_LEN
kenjiArai 1:9db0e321a9f4 31 #define MBED_CONF_CELLULAR_MAX_CP_DATA_RECV_LEN 1358
kenjiArai 1:9db0e321a9f4 32 #endif
kenjiArai 1:9db0e321a9f4 33
kenjiArai 1:9db0e321a9f4 34
kenjiArai 1:9db0e321a9f4 35 /**
kenjiArai 1:9db0e321a9f4 36 * @addtogroup cellular
kenjiArai 1:9db0e321a9f4 37 * @{
kenjiArai 1:9db0e321a9f4 38 */
kenjiArai 1:9db0e321a9f4 39
kenjiArai 1:9db0e321a9f4 40 /** Implements support for data transfer using
kenjiArai 1:9db0e321a9f4 41 * Control Plane CIoT EPS optimization specified in 3GPP 23.401(4.10), 3GPP 23.682(4.5.14).
kenjiArai 1:9db0e321a9f4 42 */
kenjiArai 1:9db0e321a9f4 43 class ControlPlane_netif {
kenjiArai 1:9db0e321a9f4 44 public:
kenjiArai 1:9db0e321a9f4 45 ControlPlane_netif() {}
kenjiArai 1:9db0e321a9f4 46 virtual ~ControlPlane_netif() {}
kenjiArai 1:9db0e321a9f4 47
kenjiArai 1:9db0e321a9f4 48 protected:
kenjiArai 1:9db0e321a9f4 49 friend class CellularNonIPSocket;
kenjiArai 1:9db0e321a9f4 50 friend class CellularContext;
kenjiArai 1:9db0e321a9f4 51
kenjiArai 1:9db0e321a9f4 52 /** Send data over cellular control plane
kenjiArai 1:9db0e321a9f4 53 *
kenjiArai 1:9db0e321a9f4 54 * @param cpdata Buffer of data to be sent over control plane connection
kenjiArai 1:9db0e321a9f4 55 * @param cpdata_length Length of data in bytes
kenjiArai 1:9db0e321a9f4 56 * @return Number of sent bytes on success, negative error
kenjiArai 1:9db0e321a9f4 57 * code on failure.
kenjiArai 1:9db0e321a9f4 58 */
kenjiArai 1:9db0e321a9f4 59 virtual nsapi_size_or_error_t send(const void *cpdata, nsapi_size_t cpdata_length) = 0;
kenjiArai 1:9db0e321a9f4 60
kenjiArai 1:9db0e321a9f4 61 /** Receive data over cellular control plane
kenjiArai 1:9db0e321a9f4 62 *
kenjiArai 1:9db0e321a9f4 63 * @param cpdata Destination buffer for data received from control plane connection
kenjiArai 1:9db0e321a9f4 64 * @param cpdata_length Length of data in bytes
kenjiArai 1:9db0e321a9f4 65 * @return Number of received bytes on success, negative error
kenjiArai 1:9db0e321a9f4 66 * code on failure.
kenjiArai 1:9db0e321a9f4 67 */
kenjiArai 1:9db0e321a9f4 68 virtual nsapi_size_or_error_t recv(void *cpdata, nsapi_size_t cpdata_length) = 0;
kenjiArai 1:9db0e321a9f4 69
kenjiArai 1:9db0e321a9f4 70 /** Receives data from the control plane PDP context
kenjiArai 1:9db0e321a9f4 71 *
kenjiArai 1:9db0e321a9f4 72 * This function is called by cellular PDP context when data
kenjiArai 1:9db0e321a9f4 73 * is received from network. It will invoke the callback set
kenjiArai 1:9db0e321a9f4 74 * by the above attach.
kenjiArai 1:9db0e321a9f4 75 *
kenjiArai 1:9db0e321a9f4 76 */
kenjiArai 1:9db0e321a9f4 77 virtual void data_received() = 0;
kenjiArai 1:9db0e321a9f4 78
kenjiArai 1:9db0e321a9f4 79 /** Register a callback on state change of the socket
kenjiArai 1:9db0e321a9f4 80 *
kenjiArai 1:9db0e321a9f4 81 * The specified callback will be called on state changes such as when
kenjiArai 1:9db0e321a9f4 82 * the socket can recv/send successfully and on when an error
kenjiArai 1:9db0e321a9f4 83 * occurs. The callback may also be called spuriously without reason.
kenjiArai 1:9db0e321a9f4 84 *
kenjiArai 1:9db0e321a9f4 85 * The callback may be called in an interrupt context and should not
kenjiArai 1:9db0e321a9f4 86 * perform expensive operations such as recv/send calls.
kenjiArai 1:9db0e321a9f4 87 *
kenjiArai 1:9db0e321a9f4 88 * @param callback Function to call on state change
kenjiArai 1:9db0e321a9f4 89 * @param data Argument to pass to callback
kenjiArai 1:9db0e321a9f4 90 */
kenjiArai 1:9db0e321a9f4 91 virtual void attach(void (*callback)(void *), void *data) = 0;
kenjiArai 1:9db0e321a9f4 92 };
kenjiArai 1:9db0e321a9f4 93
kenjiArai 1:9db0e321a9f4 94 /**
kenjiArai 1:9db0e321a9f4 95 * @}
kenjiArai 1:9db0e321a9f4 96 */
kenjiArai 1:9db0e321a9f4 97
kenjiArai 1:9db0e321a9f4 98 } // mbed namespace
kenjiArai 1:9db0e321a9f4 99 #endif