Proton API layout proposal

Summary

Package	Description
proton	Core protocol model and utility classes
proton.event	Event infrastructure
proton.codec	Data encode and decode
proton.reactor	IO integration and event dispatch
proton.handlers	Library of event handlers
proton.security	Encryption and authentication
proton.messenger	A home for the Messenger API
proton.extras	Extra classes that extend core Proton functionality
proton.types	Data types not supplied by the host language
proton.util	Utility classes not supplied by the host language

The 'handlers' package is expected to contain more classes over time as the number of event-handling behaviors grow. By contrast, the other packages are expected to mostly stop growing once the necessary functionality is in place.

The 'event' and 'codec' packages are expected to see less mainstream usage and are therefore stowed a little further away.

The base Proton exception or error class goes in 'proton', but subclasses would reside in the various subpackages above.

There are some classes we intend to deprecate or remove: Connector, Listener, Driver.

Package 'proton'

Connection, Session, Link, Terminus, Delivery, Transport, Address, Condition - AMQP model objects
Message - Important user-facing utility classes
ProtonException - Core error handling

Package 'proton.event'

Collector, Event, EventType, EventHandler
Perhaps also BaseHandler and BaseReactor

Package 'proton.codec'

Encoder, Decoder

Package 'proton.types'

Timestamp, Described, UnsignedLong, etc.
Map, List, Uuid

Package 'proton.reactor'

Reactor, Container

Package 'proton.handlers'

This may grow to have subpackages.

MessagingHandler, IncomingMessageHandler, OutgoingMessageHandler

Package 'proton.util'

These are simple extensions to the language-provided standard library.

Url

Possible subpackages

proton.util.logging
proton.util.framing

Package 'proton.security'

SSL, SASL

Package 'proton.messenger'

Messenger, Subscription

Package 'proton.extras'

BlockingConnection

Child pages