net_test_api.h

00001 /*
00002  * Copyright (c) 2016-2017, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 
00018 /**
00019  * \file net_ipv6_api.h
00020  * \brief IPv6 configuration API.
00021  */
00022 
00023 #ifndef NET_TEST_API_H_
00024 #define NET_TEST_API_H_
00025 
00026 #include "ns_types.h"
00027 
00028 /**
00029  * \brief Makes TCP protocol drop given number of packets from a particular state (TX side).
00030  *
00031  * Testing API for TCP retransmission mechanism after a packet is dropped in a particular state.
00032  *
00033  * \param state Particular TCP state - Identified by its number from 1-11. Numbering is from the SNMP MIB - RFC 4022.
00034  * \param count No. of packets to be dropped
00035  * \return 0 OK
00036  * \return <0 If request can't be fulfilled, i.e., Not test environment.
00037  */
00038 int8_t arm_nwk_test_tcp_drop_tx(int state, uint8_t count);
00039 
00040 /**
00041  * \brief Makes TCP protocol drop given number of packets from a particular state (RX side).
00042  *
00043  * Testing API for TCP to drop  received packets.
00044  *
00045  * \param state Particular TCP state - Identified by its number from 1-11. Numbering is from the SNMP MIB - RFC 4022.
00046  * \param count No. of packets to be dropped
00047  * \return 0 OK
00048  * \return <0 If request can't be fulfilled, i.e., Not test environment.
00049  */
00050 int8_t arm_nwk_test_tcp_drop_rx(int state, uint8_t count);
00051 
00052 /**
00053  * \brief Resets drop counters.
00054  *
00055  * Testing API for TCP reset any packet drop counters.
00056  */
00057 void arm_nwk_test_tcp_drop_reset(void);
00058 
00059 #endif //NET_TEST_API_H_