Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !7467

[C][Client]Support data callback function

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/ityuhui/yhdatacallback into master Sep 21, 2020
  • Overview 0
  • Commits 1
  • Pipelines 0
  • Changes 8

Created by: ityuhui

There is a special API design: When the client issues a http request, http server will block the request ( does not return to client ), and write some data to stream to client continuously. e.g. In kubernetes, when client issues a watch request, kube-apiserver will block this request, but write the watch event data to the stream to client once there is new event such as pod creation/deletion. Client needs to read and handle these event data.

But for now, c generator does not support this mode because apiClient_invoke and writeDataCallback have no chance to access the raw data if the request is blocking.

This PR adds a data_callback_func to writeDataCallback, if it is not NULL, it will be called to access the data received. By this means, user can inject a data_callback_func to handle when the request is blocking.

size_t writeDataCallback(void *buffer, size_t size, size_t nmemb, void *userp) {
    ...
    if (apiClient->data_callback_func) {
        apiClient->data_callback_func(&apiClient->dataReceived, &apiClient->dataReceivedLen);
    }
    ...
}

This change does not impact current request logic because apiClient->data_callback_func = NULL by default.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.
  • Run the shell script ./bin/generate-samples.shto update all Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

@wing328 @zhemant @michelealbano

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/ityuhui/yhdatacallback