Developer Guide

Concepts

  • Port: interface for a task, does not aim to cover all possible use cases (only the most used things) you could need to access underlying technology, and that is fine.
  • Adapter: implementation of a functionality for a given product/technology.
  • Manager: singleton object to manage a cross toolkit aspect. Serialization, Injection or Settings.

Toolkit Structure

The project is composed by modules, each module provide a single functionality. There are three kind of modules:

  • The ones that provide a functionality that does not depend on different implementations, like hexagon_scheduler or hexagon_core. Their name always start with the hexagon_ prefix. These modules can depend on several Ports, but never on Adapters (see below).
  • Modules that define a "Port": these are interfaces to a feature that may have different implementations (ie: port_http_server or port_store). They can not be used by themselves and in their place, an adapter implementing them should be added to the list of dependencies. These modules names start with the port_ prefix. Ports are independent from each other.
  • Adapter modules, which are Port implementations for a given tool. store_mongodb and messaging_rabbitmq are examples of this type of modules. Adapter names must start with their port name.

Hexagon Core

The Hexagon Core module is used by all other libraries, so it would be added to your project anyway just by using any adapter.

The main features it has are:

Other Modules

The following libraries provide extra features not bound to different implementations. They will not use dependencies outside the Hexagon toolkit.

  • Scheduling: this module allows services to execute tasks periodically using Cron expressions.

Toolkit Ports

These modules define features that need an specific implementation. You can use many implementations of each port at the same time. You can even provide a custom implementations if you want to optimize a particular use case.

These are the implemented ports:

  • HTTP Server: describes how to use HTTP routing and HTML templates for Web services.
  • HTTP Client: documentation to use the HTTP client module to connect to other services.
  • Storage: gives an overview of how to store data using different data stores.
  • Messaging: how to support asynchronous communication with messages through message brokers.
  • Templates: describes how to render pages using template engines.

Comments