MessageSettings Class

Article
12/30/2016

Contains settings shared by all message types for sending a message to a management point. Not all properties are recognized by all senders.

Namespace: Microsoft.ConfigurationManagement.Messaging.Framework
Assembly: Microsoft.ConfigurationManagement.Messaging (in Microsoft.ConfigurationManagement.Messaging.dll)

Inheritance Hierarchy

System.Object
Microsoft.ConfigurationManagement.Messaging.Framework.MessageSettings

Syntax

[SerializableAttribute]
public sealed class MessageSettings : IMessageSettings

[SerializableAttribute]
public ref class MessageSettings sealed : IMessageSettings

<SerializableAttribute>
Public NotInheritable Class MessageSettings
    Implements IMessageSettings

Constructors

	Name	Description
	MessageSettings()	Initializes a new instance of the MessageSettings class.

Properties

	Name	Description
	BitsUpload	Gets or sets a value that indicates whether BITS will be used to send the message payload to the management point. Not all management point endpoints are compatible with BITS, therefore, use caution when setting this value to true. Additionally, not all senders support BITS uploading.
	Compression	Gets or sets the compression used with this message.
	CompressionLevel	Gets or sets the compression level used for sending compression. This property is ignored if compression is not enabled.
	DefaultSecurityMode	Controls the default security mode for messages. This property is static and will carry across the entire process. The default value is mixed mode.
	Endpoint	Gets or sets the management point endpoint that the message will be sent to. Important: Do not set this value by anything outside of the messaging library (except for AdhocMessage ). All messages should set this appropriately (except for AdhocMessage ).
	HostName	Gets or sets the management point host name that the message will be sent to.
	HttpPort	Gets or sets the HTTP port to use for sending the message, if applicable. Not all senders will recognize this property value. For best compatibility, use the GetCommunicationPort method to get the most appropriate port.
	HttpsPort	Gets or sets the HTTPS (TLS/SSL) port to use for sending the message, if applicable. Not all senders will recognize this property value. For best compatibility, use the GetCommunicationPort method to get the most appropriate port.
	MessageProperties	Gets special message properties. This property is generally used by messages and should not be set by external code.
	MessageSourceType	Gets or sets the optional source type for the message.
	OverrideValidityChecks	Gets or sets a value that indicates whether the ability to override validity checking is enabled. If true, messages that have required properties that are null or empty will not fail to send.
	PostSendActionsEnabled	Gets or sets a value that indicates whether a post-send asynchronous task should be run, if supported by the message.
	ReplyCompression	Gets or sets the reply compression used with this message.
	ReplyEndpoint	Gets or sets the endpoint to direct message replies to. This setting is only relevant for senders. Do not change this property manually except under special circumstances.
	Security	Gets the security settings for the message.
	SecurityMode	Gets or sets the site security mode. The default value is mixed mode.
	SenderProperties	Gets any special configuration settings for specific senders. Some messages may require special sender-specific settings that can be set here.
	ServerRoleType	Gets or sets the optional server role type for the message.
	SourceHost	Gets or sets the host name from which the message is sourced. The default value is the NetBIOS name of the local computer, but can be any value.
	Timeout	Get or sets a timeout for sending the message. Not all senders will honor this timeout value. The default value is 60 seconds.

Methods

	Name	Description
	CloneSettings(MessageSettings)	Clones settings between message instances. This method can be used to preserve settings from one message to another. Settings that are specific to an implementation of a message will not be cloned.
	CloneSettings(MessageSettings, MessageCloneOptions)	Clones settings between message instances. This method can be used to preserve settings from one message to another. Settings that are specific to an implementation of a message will not be cloned.
	Equals(Object)	(Inherited from Object.)
	GetCommunicationPort()	Gets the port that should be used for communication. The port that is returned depends on the setting for the SecurityMode property. If a specific override is required, use the GetCommunicationPort(MessageSecurityMode) method.
	GetCommunicationPort(MessageSecurityMode)	Gets the port that should be used for communication. This is a hint; the actual port that should be used is specific to the implementation.
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	SetCommunicationPort(MessageSecurityMode, UInt16)	Sets the communication port.
	ToString()	(Inherited from Object.)

Fields

	Name	Description
	DefaultHttpPort	Default port for HTTP communication.
	DefaultHttpsPort	Default port for HTTPS communication.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via