Missing documentation for main features

[ramunasd]

There is a lot of supported AMQP features but documentation is missing. People keep asking how to use this library using github issues but this way is no go.

Would be nice to have a brief summary about all main features and use cases in some "Read the docs" style documentation.

Here are things I would like to have documented:

Exchange types and how to declare them:

• simple direct
• fanout demo/amqp_consumer_fanout_1.php
• topic
• headers Headers exchange - php example #554 demo/amqp_message_headers_recv.php

Queue parameters and what they mean.

#731 #741

• exclusive queue demo/amqp_consumer_exclusive.php

Consumer features

• consumer cancel how to get Consumer Cancel Notify #704
• publish confirm demo/amqp_publisher_with_confirms.php
• handling POSIX signals demo/amqp_consumer_signals.php
• non blockig consume demo/amqp_consumer_non_blocking.php

Additional features:

• delayed messages demo/delayed_message.php
• dead lettering demo/delayed_message.php
• exchange to exchange binding demo/e2e_bindings.php

Connection parameters:

• how to set connection name How to set connection name ? #728
• heartbeats Enabling heartbeat by default throws PHP Fatal error #699 Long running producer -- can send messages to queues already declared, but can't declare new queues #703 Heartbeat problem when the consumer consume a message for too long #725

[fuzzy76]

Another way to improve the situation could be to expand the doc headers in the code. As it is now it just lists all arguments for functions without explaining what each is for. That would make http://php-amqplib.github.io/php-amqplib/ much more useful.

[lukebakken]

@fuzzy76 this is open-source software maintained by volunteers. If you have time to contribute via a pull request, we would appreciate it.

[jiaoyang3]

I wrote some examples
https://github.com/jiaoyang3/rabbitmq-demo-for-php