MSMQ Registry Settings (Compact 2013)

3/26/2014

Message Queuing (MSMQ) can be configured by setting registry information or by running the MSMQAdm utility.

Note

You must configure MSMQ after you set the computer name and current time.
The current time is used for generating the globally unique identifier (GUID). If the time is not set properly, more than one computer might be assigned the same GUID. For this reason, configuration does not proceed during the first cold boot. Instead, the user is responsible for the configuration.

Note

The default registry values vary depending on which catalog items are included in your Windows Embedded Compact OS design.

The following table describes the registry settings that you can change to configure MSMQ. These registry settings are located in HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\MSMQ\SimpleClient.

Name

Type

Description

Default Value

AllowResponse

REG_SZ

Acknowledges the sender. MSMQ sends acknowledgements when the PROPID_M_ACKNOWLEDGE property is set.

If the value is "No", MSMQ sends the acknowledgment using the host name, such as www.adatum.com.

If the value is "Yes", MSMQ sends the acknowledgment using the IP address of the sender, such as 192.168.0.0.

Default setting is "No."

BaseDir

REG_SZ

Directory used for queue information and message storage.

Default setting is "\Temp\MSMQ."

BinaryEnabled

REG_SZ

Indicates whether MSMQ supports outgoing messages.

If the value is "No", MSMQ receives incoming messages, but does not send outgoing messages.

If the value is "Yes", MSMQ supports the native MSMQ and the SOAP protocol.

Ee498409.security(en-us,WinEmbedded.80).gifSecurity Note:
Setting the value to "No" can help improve security by allowing only specific types of messages.
Ee498409.note(en-us,WinEmbedded.80).gifNote:
For example, if MSMQ is used in a private network, you can set BinaryEnabled to "Yes" to support native MSMQ and SOAP-based protocols.
Ee498409.note(en-us,WinEmbedded.80).gifNote:
If MSMQ is used with the Internet, you can set BinaryEnabled to "No" and SrmpEnabled to "Yes" to support only SOAP-based protocol.

Default setting is "No."

CEStartAtBoot

REG_DWORD

Indicates whether MSMQ starts automatically when the device starts.

Windows Embedded Compact-specific entry.

If this value is 0, MSMQ will not start at boot time but can be started using the MSMQAdm utility.

Default value is 1.

CETrackNetwork

REG_SZ

You can set the value to "Yes" or "No."

If the value is "Yes", MSMQ attempts to resend immediately after the network reconnects, instead of following the standard resend schedule.

Default value is "Yes."

DebugOutputChannels

REG_DWORD

Mask of the MSMQ debug output channels.

Default value is 2.

DebugOutputMask

REG_DWORD

Mask of the enabled debug zones.

Default value is 17.

DebugQueue

REG_SZ

Queue used to route debugging.

None.

DefaultLocalQuota

REG_DWORD

If this value is not present in the registry, the default incoming quota is 1024 kilobytes.

Incoming queue quota, in kilobytes.

Default value is 1024.

DefaultQuota

DWORD

Queue quota, in kilobytes, for message storage by a remote queue. The maximum default queue size and the size of output queues are expressed in kilobytes.

Default setting is 256.

FSMaxTimeout

REG_DWORD

Time-out, in seconds, for an installable file system.

If the MSMQ base directory is not found on startup, MSMQ waits for this period of time, rechecking every second before failing.

None.

HostName

REG_SZ

Host name to override the host name of the machine.

If this value is not present in the registry, information is queried dynamically from the network.

Default is not set in the registry.

LanRetrySchedule

REG_DWORD

If there are no network interfaces, the next attempt to connect is shifted by this value, in seconds, instead of the retry schedule.

If 0, the existence of network interfaces is not checked and the connection schedule is followed.

Default is not set in the registry.

LogSize

REG_DWORD

Size of the MSMQ log file.

Default value is 1000.

MachineQuota

REG_DWORD

Machine queue quota, in kilobytes.

If this value is not present in the registry, the default machine quota is 2048 kilobytes.

Default value is 2048.

MessageID

REG_DWORD

Current message identifier, accurate within 1,000 messages.

The MSMQ client sets this identifier for backup/restore purposes.

We recommend that you do not change this value.

None.

OrderAckScale

REG_DWORD

Multiplier for transactional acknowledgement periods and time-outs.

Default value is 5.

OrderAckWindow

REG_DWORD

Number of packets sent per transactional queue until the transactional receipt arrives.

We recommend that you do not change this value.

None.

OutFRSQueue

REG_SZ

Outgoing Falcon Routing Server (FRS) queue format name.

This name must be a direct format name.

If another name is used, you cannot configure the outgoing FRS queue.

None.

PingPort

REG_DWORD

Machine User Datagram Protocol (UDP) port that the MQPing service is monitoring. This ping port is set by the registration utility.

Do not change the ping port setting.

Default value is 3527 set by the registration utility.

PingTimeout

REG_DWORD

Default is not set in the registry.

Time-out for response to MQPing.

If this value is 0, pinging is disabled and connections are attempted immediately.

None.

Port

REG_DWORD

Machine TCP/IP port that MSMQ is monitoring. This port is set to 1801 by the registration utility.

Do not change the port setting.

Default value is 1801.

QueueManagerGUID

REG_BINARY

GUID of the queue manager, which is used for session protocols between Windows Embedded Compact implementations and Windows desktop implementations.

Default is not set in the registry.

RetrySchedule

REG_BINARY

Array of little-endian short (2-byte) values that provide the retry schedule of the time intervals for each subsequent attempt to connect to the server.

Default value is 300, 300, 600, 600, 900.

SrmpEnabled

REG_SZ

You can set the value to "Yes" or "No".

If this value is "Yes", MSMQ supports the SOAP-based protocol.

Ee498409.security(en-us,WinEmbedded.80).gifSecurity Note:
Setting the value to "No" can help improve security by allowing only specific types of messages.
Ee498409.note(en-us,WinEmbedded.80).gifNote:
For example, if MSMQ is used in a private network, you can set BinaryEnabled to "Yes" to support native MSMQ and SOAP-based protocols.
Ee498409.note(en-us,WinEmbedded.80).gifNote:
If MSMQ is used on a web site, you can set BinaryEnabled to "No" and SrmpEnabled to "Yes" to support only SOAP-based protocol.

Default value is "No", which disables SOAP Reliable Messaging Protocol (SRMP).

UntrustedNetwork

REG_SZ

You can set the value to "Yes" or "No".

Disables message routing.

Ee498409.security(en-us,WinEmbedded.80).gifSecurity Note:
This value can be used to help protect a device from connecting to untrusted networks.

Default setting is "Yes", which indicates that the current network is untrusted.

The following table describes the registry settings that you can change to handle dropped connections that can result from slow connections to wireless LANs.

Name

Type

Description

Default Value

ConnectionTimeout

REG_DWORD

Time-out, in seconds, for a connection to complete.

None.

IdleTimeout

REG_DWORD

Time interval, in seconds, before the connection closes because there is no incoming message.

Default value is 5 minutes.

MaxAckTimeout

REG_DWORD

Maximum negotiated time-out, in seconds, for receiving acknowledgement for session-level messages.

None.

MinAckTimeout

REG_DWORD

Minimum negotiated time-out, in seconds, for receiving acknowledgement for session-level messages.

None.

MinStoreAckTimeout

REG_DWORD

Minimum negotiated time-out, in seconds, for receiving acknowledgement for session-level messages before they are stored.

None.

The following table describes the registry settings that you can change to configure SRMP. These registry settings are located in HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\MSMQ\SimpleClient\SRMP.

Value

Type

Description

Default value

MaxPost

REG_DWORD

Maximum size of the buffer, in bytes, that the ISAPI extension (SrmpIsapi) reads off the wire when processing SRMP messages over HTTP.

Messages longer than the maximum value are rejected and a 413 status code ("Request Entity Too Large") is sent to the client.

Default value is 131072 bytes.

See Also

Reference

MSMQ Reference

Other Resources

MSMQ Message Queuing
MSMQ Message Queuing