esnet/iperf

libiperf catchup

Open

#595 opened on Jun 7, 2017

View on GitHub
 (4 comments) (2 reactions) (0 assignees)C (4,946 stars) (1,083 forks)batch import
Help Wantedenhancement

Description

Context

  • Version of iperf3: any

  • Hardware: all

  • Operating system (and distribution, if any): all

Enhancement Request

A number of enhancements have been made to iperf3 that caused the iperf_test and iperf_settings to grow some new members corresponding to new configuration parameters. In many cases, the libiperf API was not extended to include getters and setters for these parameters, with the result that programs using libiperf don't have access to all of the test parameters that can be specified from the command-line.

The libiperf API should catch up to the reality of these structure definitions.

Contributor guide

Tech stack
c
Domain
api
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
C programmingUnderstanding of iperf library API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Review the current iperf test and iperf settings structures in the iperf source code (likely in src/iperf api.h). Identify which new members have been added to these structs that lack corresponding getter/setter functions in the libiperf API. Then, for each missing member, implement a getter and setter function following the existing pattern (e.g., iperf get test * and iperf set test *). Update the API header and source files accordingly. Check the issue comments for any specific parameters mentioned.