net_test_api.h

00001 /*
00002  * Copyright (c) 2016 ARM Limited. All rights reserved.
00003  *
00004  * SPDX-License-Identifier: LicenseRef-PBL
00005  *
00006  * Licensed under the Permissive Binary License, Version 1.0 (the "License"); you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  * https://www.mbed.com/licenses/PBL-1.0
00010  *
00011  * See the License for the specific language governing permissions and limitations under the License.
00012  *
00013  */
00014 
00015 /**
00016  * \file net_ipv6_api.h
00017  * \brief IPv6 configuration API.
00018  */
00019 
00020 #ifndef NET_TEST_API_H_
00021 #define NET_TEST_API_H_
00022 
00023 #include "ns_types.h"
00024 
00025 /**
00026  * \brief Makes TCP protocol drop given number of packets from a particular state (TX side).
00027  *
00028  * Testing API for TCP retransmission mechanism after a packet is dropped in a particular state.
00029  *
00030  * \param state Particular TCP state - Identified by its number from 1-11. Numbering is from the SNMP MIB - RFC 4022.
00031  * \param count No. of packets to be dropped
00032  * \return 0 OK
00033  * \return <0 If request can't be fulfilled, i.e., Not test environment.
00034  */
00035 int8_t arm_nwk_test_tcp_drop_tx(int state, uint8_t count);
00036 
00037 /**
00038  * \brief Makes TCP protocol drop given number of packets from a particular state (RX side).
00039  *
00040  * Testing API for TCP to drop  received packets.
00041  *
00042  * \param state Particular TCP state - Identified by its number from 1-11. Numbering is from the SNMP MIB - RFC 4022.
00043  * \param count No. of packets to be dropped
00044  * \return 0 OK
00045  * \return <0 If request can't be fulfilled, i.e., Not test environment.
00046  */
00047 int8_t arm_nwk_test_tcp_drop_rx(int state, uint8_t count);
00048 
00049 /**
00050  * \brief Resets drop counters.
00051  *
00052  * Testing API for TCP reset any packet drop counters.
00053  */
00054 void arm_nwk_test_tcp_drop_reset(void);
00055 
00056 #endif //NET_TEST_API_H_