DongEun Koak / NetworkSocketAPI

NetworkSocketAPI

Dependencies:   DnsQuery

Dependents:   HelloWizFi250Interface

Fork of NetworkSocketAPI by NetworkSocketAPI

MeshInterface.h@104:d28d8b508e7c, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:26:21 2016 -0500
Revision:
104:d28d8b508e7c
Parent:
89:b1d417383c0d 
Revised documentation for Interface classes

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 104:d28d8b508e7c 1 /* MeshInterface
Christopher Haster 89:b1d417383c0d 2 * Copyright (c) 2015 ARM Limited
Christopher Haster 89:b1d417383c0d 3 *
Christopher Haster 89:b1d417383c0d 4 * Licensed under the Apache License, Version 2.0 (the "License");
Christopher Haster 89:b1d417383c0d 5 * you may not use this file except in compliance with the License.
Christopher Haster 89:b1d417383c0d 6 * You may obtain a copy of the License at
Christopher Haster 89:b1d417383c0d 7 *
Christopher Haster 89:b1d417383c0d 8 * http://www.apache.org/licenses/LICENSE-2.0
Christopher Haster 89:b1d417383c0d 9 *
Christopher Haster 89:b1d417383c0d 10 * Unless required by applicable law or agreed to in writing, software
Christopher Haster 89:b1d417383c0d 11 * distributed under the License is distributed on an "AS IS" BASIS,
Christopher Haster 89:b1d417383c0d 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Christopher Haster 89:b1d417383c0d 13 * See the License for the specific language governing permissions and
Christopher Haster 89:b1d417383c0d 14 * limitations under the License.
Christopher Haster 89:b1d417383c0d 15 */
Christopher Haster 89:b1d417383c0d 16
Christopher Haster 89:b1d417383c0d 17 #ifndef MESH_INTERFACE_H
Christopher Haster 89:b1d417383c0d 18 #define MESH_INTERFACE_H
Christopher Haster 89:b1d417383c0d 19
Christopher Haster 89:b1d417383c0d 20 #include "NetworkInterface.h"
Christopher Haster 89:b1d417383c0d 21
Christopher Haster 89:b1d417383c0d 22 /** MeshInterface class
Christopher Haster 104:d28d8b508e7c 23 *
Christopher Haster 104:d28d8b508e7c 24 * Common interface that is shared between mesh hardware
Christopher Haster 89:b1d417383c0d 25 */
Christopher Haster 89:b1d417383c0d 26 class MeshInterface : public NetworkInterface
Christopher Haster 89:b1d417383c0d 27 {
Christopher Haster 89:b1d417383c0d 28 public:
Christopher Haster 89:b1d417383c0d 29 /** Start the interface
Christopher Haster 104:d28d8b508e7c 30 *
Christopher Haster 89:b1d417383c0d 31 * @return 0 on success, negative on failure
Christopher Haster 89:b1d417383c0d 32 */
Christopher Haster 89:b1d417383c0d 33 virtual int connect() = 0;
Christopher Haster 89:b1d417383c0d 34
Christopher Haster 89:b1d417383c0d 35 /** Stop the interface
Christopher Haster 104:d28d8b508e7c 36 *
Christopher Haster 89:b1d417383c0d 37 * @return 0 on success, negative on failure
Christopher Haster 89:b1d417383c0d 38 */
Christopher Haster 89:b1d417383c0d 39 virtual int disconnect() = 0;
Christopher Haster 89:b1d417383c0d 40 };
Christopher Haster 89:b1d417383c0d 41
Christopher Haster 89:b1d417383c0d 42 #endif