Mistake on this page?
Report an issue in GitHub or email us
SclAccessPoint.h
1 /*
2  * Copyright 2018-2020 Cypress Semiconductor Corporation
3  * SPDX-License-Identifier: Apache-2.0
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef SCL_ACCESS_POINT_H
19 #define SCL_ACCESS_POINT_H
20 
21 #include "netsocket/WiFiAccessPoint.h"
22 #include "scl_types.h"
23 
24 /* Enum for scan result type */
25 enum scan_result_type {
26  SRES_TYPE_WIFI_ACCESS_POINT,
27  SRES_TYPE_SCL_ACCESS_POINT
28 };
29 
30 /** SclAccessPoint class
31  *
32  * Class that represents a Scl Access Point
33  * which contains additional Scl specific information
34  */
36 public:
38  SclAccessPoint(nsapi_wifi_ap_t ap, scl_bss_type_t bss_type, uint8_t *ie_ptr, uint32_t ie_len);
39 
40  /** Define move assignment and prevent copy-assignment
41  *
42  * Due to IE element data could have large memory footprint,
43  * only move assignment is allowed.
44  */
46  SclAccessPoint &operator=(const SclAccessPoint &rhs) = delete;
47 
48  /** Get SCL access point's bss type
49  *
50  * @return The scl_bss_type_t of the access point
51  */
52  scl_bss_type_t get_bss_type() const;
53 
54  /** Get SCL access point's IE data
55  *
56  * @return The pointer to ie data buffer
57  */
58  uint8_t *get_ie_data() const;
59 
60  /** Get SCL access point's IE length
61  *
62  * @return The ie data length
63  */
64  uint32_t get_ie_len() const;
65 
66  virtual ~SclAccessPoint();
67 
68 private:
69  scl_bss_type_t _bss_type;
70  uint8_t *_ie_ptr; /**< Pointer to received Beacon/Probe Response IE(Information Element) */
71  uint32_t _ie_len; /**< Length of IE(Information Element) */
72 };
73 
74 #endif
uint32_t get_ie_len() const
Get SCL access point&#39;s IE length.
WiFiAccessPoint()
WiFiAccessPoint lifetime.
SclAccessPoint & operator=(SclAccessPoint &&rhs)
Define move assignment and prevent copy-assignment.
nsapi_wifi_ap structure
Definition: nsapi_types.h:308
scl_bss_type_t get_bss_type() const
Get SCL access point&#39;s bss type.
uint8_t * get_ie_data() const
Get SCL access point&#39;s IE data.
SclAccessPoint class.
WiFiAccessPoint class.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.