Transports

PreviousMessage Types NextLogging

Last updated 2 months ago

Get Help

FAQ Legacy Documentation Support / Contact Us

Get AMPS

Evaluate Develop

60East Resources

Website Privacy Policy

The Transports element configures how AMPS communicates with publishers and subscribers, as well as how AMPS accepts connections for replication. The Transports element is a container for one or more Transport elements. Each Transport is a combination of a network transport, an AMPS header protocol, and a message type.

A Transport also specifies the Authentication used to validate the users that connect, and the Entitlement used to enforce permissions for users that connect over that transport.

AMPS supports a variety of network transports, header protocols and message formats for communication between publishers and subscribers. This section describes how to configure a Transport.

For more information on Transports, see the Transports section of the AMPS User Guide.

Starting with 5.1, AMPS supports encrypting client connections using the SSL (Secure Sockets Layer) network protocol. The following parameters apply to transports that use SSL. While AMPS performs additional configuration validation if the transport is configured with a Type of tcps, if a Certificate and PrivateKey are specified for a Transport of tcp type, AMPS will use SSL for that Transport. These options also apply to transports of type amps-replication-secure.

For protocols of Type amps-unix, AMPS requires the following additional configuration option:

For protocols of Type websocket, AMPS supports the following additional configuration option:

Transports Example with Slow Client Management


<AMPSConfig>
    ...

    <MessageMemoryLimit>10GB</MessageMemoryLimit>
    <MessageDiskPath>/mnt/fastio/AMPS/offline</MessageDiskPath>
    <ClientMessageAgeLimit>30s</ClientMessageAgeLimit>

    ...

    <Transports>
        <!-- This transport shares the 10GB MessageMemoryLimit
            defined for the instance. -->
        <Transport>
            <Name>regular-tcp</Name>
            <Type>tcp</Type>
            <InetAddr>9007</InetAddr>
            <Protocol>amps</Protocol>
        </Transport>

        <!-- This transport shares the 10GB MessageMemoryLimit
            defined for the instance. -->
        <Transport>
            <Name>regular-websocket</Name>
            <Type>tcp</Type>
            <InetAddr>9008</InetAddr>
            <Protocol>websocket</Protocol>
        </Transport>

        <!-- This transport has a separate 35GB MessageMemoryLimit
            and a 70GB MessageDiskLimit. It uses the instance-wide
            30s parameter for the ClientMessageAgeLimit -->
        <Transport>
            <Name>highpri-tcp</Name>
            <Type>tcp</Type>
            <InetAddr>9995</InetAddr>
            <MessageMemoryLimit>35GB</MessageMemoryLimit>
            <MessageDiskLimit>70GB</MessageDiskLimit>
            <Protocol>amps</Protocol>
        </Transport>
    </Transports>
</AMPSConfig>

Transports Example with Transport Filter

<AMPSConfig>
    <Transports>

        <Transport>
            <Name>translate-legacy-topics</Name>
            <Type>tcp</Type>
            <InetAddr>9017</InetAddr>
            <Protocol>amps</Protocol>
            <TransportFilter>
                <Module>amps-topic-translator</Module>
                <Options>
                   <Topic>orders_for_northamerica:NAOrders</Topic>
                   <Topic>catalog_items:Catalog</Topic>
                   <Topic>customer_.*:Customers</Topic>
                </Options>
            </TransportFilter>
        </Transport>

    </Transports>
</AMPSConfig>

TLS/SSL Transport Example

<AMPSConfig>
    <Transports>

        <Transport>
            <Name>ssl-all-message-types</Name>
            <Type>tcps</Type>
            <InetAddr>9007</InetAddr>
            <Protocol>amps</Protocol>
            <Certificate>${AMPS_INSTALL}/cert.pem</Certificate>
            <PrivateKey>${AMPS_INSTALL}/key.pem</PrivateKey>
            <Ciphers>HIGH:!aNULL</Ciphers>
        </Transport>

    </Transports>
</AMPSConfig>