Client configuration

Client configuration enables you to customize the behavior of your Signaling client instance according to your app's requirements.

Understand the tech

When initializing a Signaling client instance, configure any or all of the following features:

• Geographical area access When a user joins a channel, Signaling SDK automatically connects them to the closest geographical region of Agora SDRTN®. However, to comply with local laws and regulations, you may want to specify or restrict connections to a specific geographical area. Agora enables you to control and customize data routing in your app by specifying the Agora SDRTN® region users connect to.

• Enable proxy connection You use a proxy connection to ensure reliable connectivity for your users when they connect from an environment with a restricted network. This helps in maintaining a stable connection even in environments with network restrictions.

• Private deployment Private deployment enables you to deploy and manage the Signaling environment on your own infrastructure rather than using Agora services. This feature is fully supported since version 2.2.0.

• Logging Logging enables you to output detailed information from the SDK for locating and fixing problems during the development and testing phases. By configuring logging settings, you can control the amount and type of information logged by the SDK.

• Data encryption Enabling encryption ensures that only authorized users are able to read messages sent through Signaling. Signaling provides built-in encryption methods that guarantee data confidentiality during transmission. For implementation details, see Data encryption.

Prerequisites

Ensure that you have integrated the Signaling SDK in your project and implemented the framework functionality from the SDK quickstart page.

Configure the client instance

This section explains how to set up and customize various features when you initialize a Signaling client instance.

Geographical area configuration

To specify a geographical area for Agora SDRTN® connections, refer to the following code:

// Set whitelist and blacklist areas
AgoraRTM.setArea({ areaCodes: ["GLOBAL"], excludedArea: "CHINA" })

Proxy configuration

In some environments with restricted network services, you may need to set up a proxy service to access external resources. Signaling supports configuring a proxy service. You enable this feature during the Signaling instance initialization.

const { RTM } = AgoraRTM;
const appId = "your_appId";
const userId = "your_userId";
const rtmConfig = { cloudProxy: true };
const rtm = new RTM(appId, userId, rtmConfig);

Private deployment configuration

Agora is committed to offering its customers flexible, secure, and customizable solutions. Since version 2.2.0, Signaling supports private deployments. This feature enables you to deploy and manage the Signaling environment yourself, giving you more control over your data and systems.

Signaling provides MESSAGE and STREAM services. Choose one or both services based on your needs and budget. The following code shows you how to configure a private environment that deploys both services simultaneously:

const appId = "your_appId";
const userId = "your_userId";
const rtmConfig = {
    privateConfig: {
        serviceType: ["MESSAGE", "STREAM"], // Service type for private deployment
        accessPointHosts: ["private.mynet.com"], // Private deployment server list, only domain name is supported
        domainMode: 2,
    }
};
const rtm = new RTM(appId, userId, rtmConfig);

Log configuration

In the development and testing phase of your app, you may need to output more detailed information to locate and fix problems. Enable log output of the SDK and set the log information level by configuring logLevel when initializing the Signaling client instance. You can view the log information in the browser console.

const { RTM } = AgoraRTM;
const appId = "your_appId";
const userId = "your_userId";
const rtmConfig = { logLevel : "debug" };
const rtm = new RTM(appId, userId, rtmConfig);

Choose the log level from the following:

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

For firewall configuration, see firewall requirements

Client configuration enables you to customize the behavior of your Signaling client instance according to your app's requirements.

Understand the tech

When initializing a Signaling client instance, configure any or all of the following features:

• Geographical area access When a user joins a channel, Signaling SDK automatically connects them to the closest geographical region of Agora SDRTN®. However, to comply with local laws and regulations, you may want to specify or restrict connections to a specific geographical area. Agora enables you to control and customize data routing in your app by specifying the Agora SDRTN® region users connect to.

• Private deployment Private deployment enables you to deploy and manage the Signaling environment on your own infrastructure rather than using Agora services. This feature is fully supported since version 2.2.0.

• Logging Logging enables you to output detailed information from the SDK for locating and fixing problems during the development and testing phases. By configuring logging settings, you can control the amount and type of information logged by the SDK.

• Data encryption Enabling encryption ensures that only authorized users are able to read messages sent through Signaling. Signaling provides built-in encryption methods that guarantee data confidentiality during transmission. For implementation details, see Data encryption.

Prerequisites

Ensure that you have integrated the Signaling SDK in your project and implemented the framework functionality from the SDK quickstart page.

Configure the client instance

This section explains how to set up and customize various features when you initialize a Signaling client instance.

Geographical area configuration

To specify a geographical area for Agora SDRTN® connections, refer to the following code:

RtmConfig rtmConfig = new RtmConfig.Builder("appid", "userId")
    .areaCode(EnumSet.of(RtmConstants.RtmAreaCode.AS, RtmConstants.RtmAreaCode.CN))
    .eventListener(eventListener)
    .build();

val rtmConfig = RtmConfig.Builder("appid", "userId")
    .areaCode(EnumSet.of(RtmConstants.RtmAreaCode.AS, RtmConstants.RtmAreaCode.CN))
    .eventListener(eventListener)
    .build()

Private deployment configuration

Agora is committed to offering its customers flexible, secure, and customizable solutions. Since version 2.2.0, Signaling supports private deployments. This feature enables you to deploy and manage the Signaling environment yourself, giving you more control over your data and systems.

Signaling provides MESSAGE and STREAM services. Choose one or both services based on your needs and budget. The following code shows you how to configure a private environment that deploys both services simultaneously:

ArrayList<String> hosts = new ArrayList&lt;&gt;();
hosts.add("x.x.x.x"); // your access point hosts list.
RtmPrivateConfig privateConfig = new RtmPrivateConfig();
privateConfig.serviceType = EnumSet.of(RtmServiceType.MESSAGE, RtmServiceType.STREAMING);
privateConfig.accessPointHosts = hosts;

RtmConfig rtmConfig = new RtmConfig.Builder("appid", "userId")
    .privateConfig(privateConfig)
    .build();

val hosts = arrayListOf("x.x.x.x") // your access point hosts list.
val privateConfig = RtmPrivateConfig().apply {
    serviceType = EnumSet.of(RtmServiceType.MESSAGE, RtmServiceType.STREAMING)
    accessPointHosts = hosts
}

val rtmConfig = RtmConfig.Builder("appid", "userId")
    .privateConfig(privateConfig)
    .build()

Connection protocol

To ensure connection stability and continuous service availability, the RTM client establishes two transmission links for each service (MESSAGE service and STREAM service) when connecting to the edge server. By default, these links use the TCP and UDP protocols, respectively. This design ensures that network issues on one link do not affect the overall transmission. Compared to other WebSocket-based message transmission solutions, RTM's redundant link design maximizes transmission stability and message delivery rate.

In some cases, users may find that their network does not support UDP port transmission, either temporarily or permanently. To ensure the dual-link design operates effectively, the SDK allows users to configure both links to use the TCP protocol. This can be done by setting the protocolType field in the RtmConfig. Below is a code example that configures both links to use the TCP protocol:

RtmConfig rtmConfig = new RtmConfig.Builder("appid", "userId")
    .protocolType(RtmProtocolType.TCP_ONLY)
    .build();

val rtmConfig = RtmConfig.Builder("appid", "userId")
    .protocolType(RtmProtocolType.TCP_ONLY)
    .build()

Log configuration

In the development and testing phase of your app, you may need to output more detailed information to locate and fix problems. Enable log output of the SDK and set the log information level by configuring RtmLogLevel when initializing the Signaling client instance.

RtmLogConfig logConfig = new RtmLogConfig();
// Set log file path
logConfig.filePath = "./logfile/";
// Set log file size
logConfig.fileSizeInKB = 512;
// Set log report level
logConfig.level = RtmLogLevel.INFO;

RtmConfig rtmConfig = new RtmConfig();
rtmConfig.userId = "your_userId";
rtmConfig.appId = "your_appId";
rtmConfig.logConfig = logConfig; // Set log config

// Initialize the client instance
try {
    mRtmClient = RtmClient.create(rtmConfig);
} catch(Exception e) {
    log(INFO, "create rtm client failed with exception: " + e.toString());
}

val logConfig = RtmLogConfig().apply {
    filePath = "./logfile/" // Set log file path
    fileSizeInKB = 512 // Set log file size
    level = RtmLogLevel.INFO // Set log report level
}

val rtmConfig = RtmConfig().apply {
    userId = "your_userId"
    appId = "your_appId"
    logConfig = logConfig // Set log config
}

// Initialize the client instance
try {
    mRtmClient = RtmClient.create(rtmConfig)
} catch (e: Exception) {
    log(INFO, "create rtm client failed with exception: " + e.toString())
}

Choose the log level from the following:

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

For firewall configuration, see firewall requirements

Client configuration enables you to customize the behavior of your Signaling client instance according to your app's requirements.

Understand the tech

When initializing a Signaling client instance, configure any or all of the following features:

• Geographical area access When a user joins a channel, Signaling SDK automatically connects them to the closest geographical region of Agora SDRTN®. However, to comply with local laws and regulations, you may want to specify or restrict connections to a specific geographical area. Agora enables you to control and customize data routing in your app by specifying the Agora SDRTN® region users connect to.

• Private deployment Private deployment enables you to deploy and manage the Signaling environment on your own infrastructure rather than using Agora services. This feature is fully supported since version 2.2.0.

• Logging Logging enables you to output detailed information from the SDK for locating and fixing problems during the development and testing phases. By configuring logging settings, you can control the amount and type of information logged by the SDK.

• Data encryption Enabling encryption ensures that only authorized users are able to read messages sent through Signaling. Signaling provides built-in encryption methods that guarantee data confidentiality during transmission. For implementation details, see Data encryption.

Prerequisites

Ensure that you have integrated the Signaling SDK in your project and implemented the framework functionality from the SDK quickstart page.

Configure the client instance

This section explains how to set up and customize various features when you initialize a Signaling client instance.

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

For firewall configuration, see firewall requirements

Client configuration enables you to customize the behavior of your Signaling client instance according to your app's requirements.

Understand the tech

When initializing a Signaling client instance, configure any or all of the following features:

• Geographical area access When a user joins a channel, Signaling SDK automatically connects them to the closest geographical region of Agora SDRTN®. However, to comply with local laws and regulations, you may want to specify or restrict connections to a specific geographical area. Agora enables you to control and customize data routing in your app by specifying the Agora SDRTN® region users connect to.

• Private deployment Private deployment enables you to deploy and manage the Signaling environment on your own infrastructure rather than using Agora services. This feature is fully supported since version 2.2.0.

• Logging Logging enables you to output detailed information from the SDK for locating and fixing problems during the development and testing phases. By configuring logging settings, you can control the amount and type of information logged by the SDK.

• Data encryption Enabling encryption ensures that only authorized users are able to read messages sent through Signaling. Signaling provides built-in encryption methods that guarantee data confidentiality during transmission. For implementation details, see Data encryption.

Prerequisites

Ensure that you have integrated the Signaling SDK in your project and implemented the framework functionality from the SDK quickstart page.

Configure the client instance

This section explains how to set up and customize various features when you initialize a Signaling client instance.

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

For firewall configuration, see firewall requirements

Client configuration enables you to customize the behavior of your Signaling client instance according to your app's requirements.

Understand the tech

When initializing a Signaling client instance, configure any or all of the following features:

• Geographical area access When a user joins a channel, Signaling SDK automatically connects them to the closest geographical region of Agora SDRTN®. However, to comply with local laws and regulations, you may want to specify or restrict connections to a specific geographical area. Agora enables you to control and customize data routing in your app by specifying the Agora SDRTN® region users connect to.

• Private deployment Private deployment enables you to deploy and manage the Signaling environment on your own infrastructure rather than using Agora services. This feature is fully supported since version 2.2.0.

• Logging Logging enables you to output detailed information from the SDK for locating and fixing problems during the development and testing phases. By configuring logging settings, you can control the amount and type of information logged by the SDK.

• Data encryption Enabling encryption ensures that only authorized users are able to read messages sent through Signaling. Signaling provides built-in encryption methods that guarantee data confidentiality during transmission. For implementation details, see Data encryption.

Prerequisites

Ensure that you have integrated the Signaling SDK in your project and implemented the framework functionality from the SDK quickstart page.

Configure the client instance

This section explains how to set up and customize various features when you initialize a Signaling client instance.

Geographical area configuration

To specify geographical areas for Agora SDRTN® connections, refer to the following code:

// Create a Set containing specific RtmAreaCode values
Set<RtmAreaCode> areaCodes = {RtmAreaCode.na, RtmAreaCode.eu};

// Use the areaCodes in RtmConfig
RtmConfig config = RtmConfig(
  areaCode: areaCodes
);

Private deployment configuration

Agora is committed to offering its customers flexible, secure, and customizable solutions. Since version 2.2.0, Signaling supports private deployments. This feature enables you to deploy and manage the Signaling environment yourself, giving you more control over your data and systems.

Signaling provides MESSAGE and STREAM services. Choose one or both services based on your needs and budget. The following code shows you how to configure a private environment that deploys both services simultaneously:

final userId = 'your_userId';
final appId = 'your_appId';
late RtmClient rtmClient;

var privateConfig = RtmPrivateConfig(
    serviceType: { RtmServiceType.message, RtmServiceType.stream },
    accessPointHosts: ['private.hostname.com']);

var rtmConfig = RtmConfig( privateConfig:privateConfig );

try {
    final (status,client) = await RTM(appId, userId, rtmConfig:rtmConfig);
    if (status.error == true) {
        print(status);
    } else {
        rtmClient = client;
        print('Initialize success!');
    }
} catch (e) {
    print('Failed to create RTM client: $e');
}

Connection protocol

To ensure connection stability and continuous service availability, the RTM client establishes two transmission links for each service (MESSAGE service and STREAM service) when connecting to the edge server. By default, these links use the TCP and UDP protocols, respectively. This design ensures that network issues on one link do not affect the overall transmission. Compared to other WebSocket-based message transmission solutions, RTM's redundant link design maximizes transmission stability and message delivery rate.

In some cases, users may find that their network does not support UDP port transmission, either temporarily or permanently. To ensure the dual-link design operates effectively, the SDK allows users to configure both links to use the TCP protocol. This can be done by setting the protocolType field in the RtmConfig. Below is a code example that configures both links to use the TCP protocol:

late RtmClient rtmClient;
const protocolType = RtmProtocolType.tcpOnly;
const rtmConfig = RtmConfig(protocolType:protocolType);
try {
    final (status,client) = await RTM("myAppId", "Tony", rtmConfig:rtmConfig);
    if (status.error == true) {
        print(status);
    } else {
        rtmClient = client;
        print('Initialization success!');
    }
} catch (e) {
    print('Failed to create RTM client: $e');
}

Log configuration

In the development and testing phase of your app, you may need to output more detailed information to locate and fix problems. Enable log output of the SDK and set the log information level by configuring level when initializing the Signaling client instance.

const logConfig = RtmLogConfig(
    filePath: './rtm_logfile/',
    fileSizeInKB: 1024,
    level: warn );

const rtmConfig = RtmConfig( logConfig:logConfig );

Choose the log level from the following:

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

For firewall configuration, see firewall requirements

Client configuration enables you to customize the behavior of your Signaling client instance according to your app's requirements.

Understand the tech

When initializing a Signaling client instance, configure any or all of the following features:

• Geographical area access When a user joins a channel, Signaling SDK automatically connects them to the closest geographical region of Agora SDRTN®. However, to comply with local laws and regulations, you may want to specify or restrict connections to a specific geographical area. Agora enables you to control and customize data routing in your app by specifying the Agora SDRTN® region users connect to.

• Private deployment Private deployment enables you to deploy and manage the Signaling environment on your own infrastructure rather than using Agora services. This feature is fully supported since version 2.2.0.

• Logging Logging enables you to output detailed information from the SDK for locating and fixing problems during the development and testing phases. By configuring logging settings, you can control the amount and type of information logged by the SDK.

• Data encryption Enabling encryption ensures that only authorized users are able to read messages sent through Signaling. Signaling provides built-in encryption methods that guarantee data confidentiality during transmission. For implementation details, see Data encryption.

Prerequisites

Ensure that you have integrated the Signaling SDK in your project and implemented the framework functionality from the SDK quickstart page.

Configure the client instance

This section explains how to set up and customize various features when you initialize a Signaling client instance.

Geographical area configuration

To specify a geographical area for Agora SDRTN® connections, refer to the following code:

const client = createAgoraRtmClient(
 new RtmConfig({
   userId: 'your_userId',
   appId: 'your_appId',
   useStringUserId: true,
   areaCode: RtmAreaCode.as | RtmAreaCode.cn, // Multiple areas using bitwise OR
   // Or use a single area:
   // areaCode: RtmAreaCode.as,
 })
);

Available area codes:

Connection protocol

To ensure connection stability and continuous service availability, the RTM client establishes two transmission links for each service (MESSAGE service and STREAM service) when connecting to the edge server. By default, these links use the TCP and UDP protocols, respectively. This design ensures that network issues on one link do not affect the overall transmission.

In some cases, users may find that their network does not support UDP port transmission. To ensure the dual-link design operates effectively, the SDK allows users to configure both links to use the TCP protocol by setting the protocolType field in the RtmConfig:

const client = createAgoraRtmClient(
 new RtmConfig({
   userId: 'your_userId',
   appId: 'your_appId',
   useStringUserId: true,
   protocolType: RtmProtocolType.tcpOnly, // Use TCP only for both links
 })
);

Available protocol types:

Presence timeout configuration

Configure the presence timeout to control how long the server waits before considering a client offline:

const client = createAgoraRtmClient(
 new RtmConfig({
   userId: 'your_userId',
   appId: 'your_appId',
   useStringUserId: true,
   presenceTimeout: 60, // Timeout in seconds (5-300 range)
 })
);

User ID type configuration

Configure whether to use string or numeric user IDs:

// Using string user IDs (recommended)
const clientString = createAgoraRtmClient(
 new RtmConfig({
   userId: 'user123',
   appId: 'your_appId',
   useStringUserId: true, // Use string user IDs
 })
);

// Using numeric user IDs
const clientNumeric = createAgoraRtmClient(
 new RtmConfig({
   userId: '1234567', // Must be numeric string when useStringUserId is false
   appId: 'your_appId',
   useStringUserId: false, // Use numeric user IDs
 })
);

Log configuration

In the development and testing phase of your app, you may need to output more detailed information to locate and fix problems. Enable log output of the SDK and set the log information level by configuring RtmLogConfig when initializing the Signaling client instance:

const logConfig = {
 filePath: './logfile/', // Log file path
 fileSizeInKB: 512, // Log file size in KB (128-1024 range)
 level: RtmLogLevel.info, // Log report level
};

const client = createAgoraRtmClient(
 new RtmConfig({
   userId: 'your_userId',
   appId: 'your_appId',
   useStringUserId: true,
   logConfig: logConfig, // Set log configuration
 })
);

Choose the log level from the following:

Encryption configuration

For enhanced security, you can enable client-side encryption:

const encryptionConfig = {
 encryptionMode: RtmEncryptionMode.aes128Gcm, // or RtmEncryptionMode.aes256Gcm
 encryptionKey: 'your_encryption_key', // 32-character string
 encryptionSalt: new Uint8Array(32), // 32-byte salt
};

const client = createAgoraRtmClient(
 new RtmConfig({
   userId: 'your_userId',
   appId: 'your_appId',
   useStringUserId: true,
   encryptionConfig: encryptionConfig, // Set encryption configuration
 })
);

Available encryption modes:

Complete configuration example

Here's a comprehensive example showing all configuration options:

 createAgoraRtmClient,
 RtmConfig,
 RtmAreaCode,
 RtmProtocolType,
 RtmLogLevel,
 RtmEncryptionMode
} from 'agora-react-native-rtm';

const logConfig = {
 filePath: './logs/',
 fileSizeInKB: 1024,
 level: RtmLogLevel.info,
};

const encryptionConfig = {
 encryptionMode: RtmEncryptionMode.aes256Gcm,
 encryptionKey: 'your_32_character_encryption_key',
 encryptionSalt: new Uint8Array(32),
};

const client = createAgoraRtmClient(
 new RtmConfig({
   userId: 'your_userId',
   appId: 'your_appId',
   useStringUserId: true,
   areaCode: RtmAreaCode.as,
   protocolType: RtmProtocolType.tcpUdp,
   presenceTimeout: 300,
   logConfig: logConfig,
   encryptionConfig: encryptionConfig,
 })
);

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

For firewall configuration, see firewall requirements

Client configuration enables you to customize the behavior of your Signaling client instance according to your app's requirements.

Understand the tech

When initializing a Signaling client instance, configure any or all of the following features:

• Geographical area access When a user joins a channel, Signaling SDK automatically connects them to the closest geographical region of Agora SDRTN®. However, to comply with local laws and regulations, you may want to specify or restrict connections to a specific geographical area. Agora enables you to control and customize data routing in your app by specifying the Agora SDRTN® region users connect to.

• Private deployment Private deployment enables you to deploy and manage the Signaling environment on your own infrastructure rather than using Agora services. This feature is fully supported since version 2.2.0.

• Logging Logging enables you to output detailed information from the SDK for locating and fixing problems during the development and testing phases. By configuring logging settings, you can control the amount and type of information logged by the SDK.

• Data encryption Enabling encryption ensures that only authorized users are able to read messages sent through Signaling. Signaling provides built-in encryption methods that guarantee data confidentiality during transmission. For implementation details, see Data encryption.

Prerequisites

Ensure that you have integrated the Signaling SDK in your project and implemented the framework functionality from the SDK quickstart page.

Configure the client instance

This section explains how to set up and customize various features when you initialize a Signaling client instance.

Geographical area configuration

To specify a geographical area for Agora SDRTN® connections, refer to the following code:

rtmConfig.areaCode = RTM_AREA_CODE_NA;
int ret = signalingEngine->initialize(rtmConfig);

Private deployment configuration

Agora is committed to offering its customers flexible, secure, and customizable solutions. Since version 2.2.0, Signaling supports private deployments. This feature enables you to deploy and manage the Signaling environment yourself, giving you more control over your data and systems.

Signaling provides MESSAGE and STREAM services. Choose one or both services based on your needs and budget. The following code shows you how to configure a private environment that deploys both services simultaneously:

std::vector<const char*> hosts;
hosts.push_back("xxx");

RtmConfig config;
config.appId = "your_appid";
config.userId = "your_name";
config.privateConfig.serviceType = RTM_SERVICE_TYPE_MESSAGE | RTM_SERVICE_TYPE_STREAM;
config.privateConfig.accessPointHosts = hosts.data();
config.privateConfig.accessPointHostsCount = hosts.size();

Connection protocol

To ensure connection stability and continuous service availability, the RTM client establishes two transmission links for each service (MESSAGE service and STREAM service) when connecting to the edge server. By default, these links use the TCP and UDP protocols, respectively. This design ensures that network issues on one link do not affect the overall transmission. Compared to other WebSocket-based message transmission solutions, RTM's redundant link design maximizes transmission stability and message delivery rate.

In some cases, users may find that their network does not support UDP port transmission, either temporarily or permanently. To ensure the dual-link design operates effectively, the SDK allows users to configure both links to use the TCP protocol. This can be done by setting the protocolType field in the RtmConfig. Below is a code example that configures both links to use the TCP protocol:

RtmConfig config;
config.appId = "appid";
config.userId = "userId";
config.protocolType = RTM_PROTOCOL_TYPE_TCP_ONLY;

Log configuration

In the development and testing phase of your app, you may need to output more detailed information to locate and fix problems. Enable log output of the SDK and set the log information level by configuring RTM_LOG_LEVEL when initializing the Signaling client instance.

RtmConfig config;
config.appId = "your_appid";
config.userId = "your_name";
config.eventHandler = new RtmEventHandler();

config.logConfig.level = RTM_LOG_LEVEL_INFO;
config.logConfig.filePath = "your_path";
config.logConfig.fileSizeInKB = 10 * 1024;

int errorCode = 0;
IRtmClient* rtmClient = createAgoraRtmClient(config, errorCode);
if (!rtmClient || errorCode != 0) {
  // create rtm client failed
}

Choose the log level from the following:

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

For firewall configuration, see firewall requirements

Client configuration enables you to customize the behavior of your Signaling client instance according to your app's requirements.

Understand the tech

When initializing a Signaling client instance, configure any or all of the following features:

• Geographical area access When a user joins a channel, Signaling SDK automatically connects them to the closest geographical region of Agora SDRTN®. However, to comply with local laws and regulations, you may want to specify or restrict connections to a specific geographical area. Agora enables you to control and customize data routing in your app by specifying the Agora SDRTN® region users connect to.

• Private deployment Private deployment enables you to deploy and manage the Signaling environment on your own infrastructure rather than using Agora services. This feature is fully supported since version 2.2.0.

• Logging Logging enables you to output detailed information from the SDK for locating and fixing problems during the development and testing phases. By configuring logging settings, you can control the amount and type of information logged by the SDK.

• Data encryption Enabling encryption ensures that only authorized users are able to read messages sent through Signaling. Signaling provides built-in encryption methods that guarantee data confidentiality during transmission. For implementation details, see Data encryption.

Prerequisites

Ensure that you have integrated the Signaling SDK in your project and implemented the framework functionality from the SDK quickstart page.

Configure the client instance

This section explains how to set up and customize various features when you initialize a Signaling client instance.

Geographical area configuration

To specify a geographical area for Agora SDRTN® connections, refer to the following code:

rtmConfig.areaCode = RTM_AREA_CODE_NA;
int ret = signalingEngine->initialize(rtmConfig);

Private deployment configuration

Agora is committed to offering its customers flexible, secure, and customizable solutions. Since version 2.2.0, Signaling supports private deployments. This feature enables you to deploy and manage the Signaling environment yourself, giving you more control over your data and systems.

Signaling provides MESSAGE and STREAM services. Choose one or both services based on your needs and budget. The following code shows you how to configure a private environment that deploys both services simultaneously:

std::vector<const char*> hosts;
hosts.push_back("xxx");

RtmConfig config;
config.appId = "your_appid";
config.userId = "your_name";
config.privateConfig.serviceType = RTM_SERVICE_TYPE_MESSAGE | RTM_SERVICE_TYPE_STREAM;
config.privateConfig.accessPointHosts = hosts.data();
config.privateConfig.accessPointHostsCount = hosts.size();

Connection protocol

To ensure connection stability and continuous service availability, the RTM client establishes two transmission links for each service (MESSAGE service and STREAM service) when connecting to the edge server. By default, these links use the TCP and UDP protocols, respectively. This design ensures that network issues on one link do not affect the overall transmission. Compared to other WebSocket-based message transmission solutions, RTM's redundant link design maximizes transmission stability and message delivery rate.

In some cases, users may find that their network does not support UDP port transmission, either temporarily or permanently. To ensure the dual-link design operates effectively, the SDK allows users to configure both links to use the TCP protocol. This can be done by setting the protocolType field in the RtmConfig. Below is a code example that configures both links to use the TCP protocol:

RtmConfig config;
config.appId = "appid";
config.userId = "userId";
config.protocolType = RTM_PROTOCOL_TYPE_TCP_ONLY;

Log configuration

In the development and testing phase of your app, you may need to output more detailed information to locate and fix problems. Enable log output of the SDK and set the log information level by configuring RTM_LOG_LEVEL when initializing the Signaling client instance.

RtmConfig config;
config.appId = "your_appid";
config.userId = "your_name";
config.eventHandler = new RtmEventHandler();

config.logConfig.level = RTM_LOG_LEVEL_INFO;
config.logConfig.filePath = "your_path";
config.logConfig.fileSizeInKB = 10 * 1024;

int errorCode = 0;
IRtmClient* rtmClient = createAgoraRtmClient(config, errorCode);
if (!rtmClient || errorCode != 0) {
  // create rtm client failed
}

Choose the log level from the following:

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

For firewall configuration, see firewall requirements

Client configuration enables you to customize the behavior of your Signaling client instance according to your app's requirements.

Understand the tech

When initializing a Signaling client instance, configure any or all of the following features:

• Geographical area access When a user joins a channel, Signaling SDK automatically connects them to the closest geographical region of Agora SDRTN®. However, to comply with local laws and regulations, you may want to specify or restrict connections to a specific geographical area. Agora enables you to control and customize data routing in your app by specifying the Agora SDRTN® region users connect to.

• Logging Logging enables you to output detailed information from the SDK for locating and fixing problems during the development and testing phases. By configuring logging settings, you can control the amount and type of information logged by the SDK.

• Data encryption Enabling encryption ensures that only authorized users are able to read messages sent through Signaling. Signaling provides built-in encryption methods that guarantee data confidentiality during transmission. For implementation details, see Data encryption.

Prerequisites

Ensure that you have integrated the Signaling SDK in your project and implemented the framework functionality from the SDK quickstart page.

Configure the client instance

This section explains how to set up and customize various features when you initialize a Signaling client instance.

Geographical area configuration

To specify a geographical area for Agora SDRTN® connections, refer to the following code:

rtmConfig.areaCode = Agora.Rtm.RTM_AREA_CODE.NA;

Log configuration

In the development and testing phase of your app, you may need to output more detailed information to locate and fix problems. Enable log output of the SDK and set the log information level when initializing the Signaling client instance.

using Agora.Rtm;

private IRtmClient rtmClient;

LogConfig logConfig = new LogConfig()
// Set log file path.
logConfig.filePath = "./logfile/";
// Set log file size.
logConfig.fileSizeInKB = 512;
// Set log report level.
logConfig.level = LOG_LEVEL.INFO;

RtmConfig config = new RtmConfig();
// Initialize logConfig.
config.logConfig = logConfig;
config.appId = "your_appId";
config.userId = "your_userId";
try
{
    rtmClient = RtmClient.CreateAgoraRtmClient(config);
    Debug.Log("RTM Client Initialize Sucessfull");
}
catch (RTMException e)
{
    Debug.Log(string.Format("{0} is failed.", e.Status.Operation ));
    Debug.Log(string.Format("Error code: {0}, due to: {1}", e.Status.ErrorCode, e.Status.Reason));
}

Choose the log level from the following:

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

For firewall configuration, see firewall requirements