Re: [cpp-netlib-devel] Documentation

[Dean M. B. <mik...@gm...>]

On Tue, Aug 12, 2008 at 5:13 PM, Glyn Matthews <gly...@gm...> wrote:
> 2008/8/12 Dean Michael Berris <mik...@gm...>
>>
>> Sounds good to me.
>>
>> Come to think of it, now that we've got something pretty usable, maybe
>> we should post something to the Boost mailing list about the progress
>> we've made so far? Or do you still think it's premature? :D
>
> More motivating examples and more documentation is required, I think.  I'd
> be interested to hear what the criticism of wider audience.
>

Sounds right to me. :D

> Useful examples might include:
> * Specializing the message type for std::wstring

This should be interesting. There's a special message tag in the
tests, it might be nice to make sure that the HTTP client works right
with wstrings as well.

> * Specializing the message for custom data structures;

This one's also a good one. Maybe I can test the vector of pair of
strings implementation in an example, and see if I get the correct
ordering.

> * A "better" HTTP example than asio (this is to demonstrate the advantages
> of this library as an addition to asio)

I think we already have this? Or do you have something else in mind? :D

> * A proxy example

This sounds good (but tricky).

> * SSL

Another interesting thought. Right now I've been hard-coding the use
of sockets that aren't HTTPS aware, so that's something that needs to
be done still. I'm thinking about it right now and it seems like
there's going to be a lot of refactoring to do with the internals of
the HTTP client to support HTTPS and maximize the code re-use. And
we're not even touching the asynchronous client implementation
thought...

> * A simple example demonstrating the use of web services (we can bundle
> tinyjson http://blog.beef.de/projects/tinyjson/ along with the examples, I
> think).
>

This should be a nice exercise for others to jump in and get their
feet wet with the HTTP client. :D

-- 
Dean Michael C. Berris
Software Engineer, Friendster, Inc.