Express v1.3.3 API Reference

Modules

Library for sending push notifications. Supports Apple APNS and Google FCM services

Establishes a connection to APNS with proper configuration

Defines APNS push message structure

Defines APNS push message alert structure

Defines APNS push message aps structure

Provides APNS SSL configuration constructor

The application. Starts the main supervisor

Defines a behaviour for configuration modules

Defines an API for APNS configuration

Defines an API for Buffer configuration

Configuration for :dev environment. Conforms Express.Configuration behaviour

Defines an API for FCM configuration

Configuration for :prod environment. Conforms Express.Configuration behaviour

Configuration for :test environment. Conforms Express.Configuration behaviour

FCM pusher. Conforms Express behaviour

Defines FCM push message structure

Defines FCM push message’s notification structure

Helper functions for a Map module

Module with functions for establishing and working with HTTP2-connection

HTTP2-client which conforms Express.Network.HTTP2.Client behaviour with chatterbox library

HTTP2-clients behaviour

Defines a structure for general HTTP2 connection

Specifies a behaviour and SSL configuration structure, where:

  • mode - either :dev or :prod
  • cert - SSL certificate
  • key - RSA key

Sends push_message synchronously to APNS. Invokes callback_fun function after response receive

Establishes HTTP2 connection and returns it

Sends push_message synchronously to FCM. Invokes callback_fun function after response receive

Sends a message to the Logger

Returns poolboy configurations

Responsible for adding a push message to Buffer. If was called with opts[:delay] > 0 - stops after job done

GenStage producer. Acts like a buffer for incoming push messages. Default buffer size is 5000 events. This size can be adjusted via config file

GenStage consumer. Retrieves push requests from Express.PushRequests.Buffer, gets a proper worker from one of poolboy pools and sends a push message via it

Dynamically spawns and supervises consumers for the push requests buffer

Defines structure for a push request. Push requests are stored in the buffer

Push requests supervisor. Responsible for the buffer, consumers and the buffer adders processes

Sets up Express’s supervision tree