Skip to content

Documentation #461

Open
Open

Description

@b-mcg

The documentation on the website showing an example of an http server does not compile and differs from the example code contained in the 0.11.0 tar archive; the example in the tar file being able to compile. Also, in the api documentation for the asynchronous server, hardly any explanation is given about the callback function of the write method. Could you please add more of an explanation of the callback function such as, what specific events cause it to be called and how one is supposed to keep a connection alive using it, which is what was mentioned in this post: http://tinyurl.com/mjt9srk.
A simple example demonstrating a callback function implementation in the docs would be beneficial to those trying to learn the library. Thank you.

Activity

  1. deanberris commented on Nov 9, 2014

    @deanberris
    Member

    Thank you for the report @b-mcg -- yes, this needs to be fixed.

  2. self-assigned this
    on Nov 9, 2014
  3. added this to the 0.11.1 milestone on Nov 9, 2014
  4. paralin commented on Feb 20, 2015

    @paralin

    +1

    I'm so confused because most of the examples in the documentation simply don't work.

  5. deanberris commented on Feb 23, 2015

    @deanberris
    Member

    @paralin Thanks -- I'm so sorry about this. Do you have time to try fixing the documentation, and submitting pull requests to make it better?

  6. paralin commented on Feb 23, 2015

    @paralin

    @deanberris Sure, I'll look into it. I'm figuring some things out now, that I think would be good to mention. Like that you should keep a single client object for your app's lifecycle because apparently having the object go out of scope leads to a hang, apparently (because resources are being released).

    I'll have a go at updating the docs soon.

  7. deanberris commented on Feb 23, 2015

    @deanberris
    Member

    Thanks @paralin -- let me know how else I can help, in case you need specific guidance on anything.

  8. modified the milestones: 0.13, 0.11.1 on Jun 14, 2016
  9. ksl67 commented on Feb 23, 2018

    @ksl67

    An example showing how to get the body of a POST request would be helpful too. See #823.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions