ConfigMgrBgbSession Class

 

Represents a client notification session with a management point.

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


[SerializableAttribute]
public ref class ConfigMgrBgbSession abstract : IDisposable

NameDescription
System_CAPS_pubpropertyClientCertificate

Gets the client certificate to use with the client notification session.

System_CAPS_pubpropertyClientVersion

Gets or sets the client version associated with the client notification session.

System_CAPS_pubpropertyHostName

Gets the client notification server host name.

System_CAPS_pubpropertyIsConnected

Indicates whether the session is connected.

System_CAPS_pubpropertyKeepAliveInterval

Gets or sets the interval for sending keep-alive notifications to the client notification endpoint on the management point. The default value is 15 minutes.

System_CAPS_pubpropertyPort

Gets the client notification server port number. The default value is 10123.

System_CAPS_pubpropertySecurityMode

Gets the message security mode, if applicable.

System_CAPS_pubpropertySessionType

Gets the client notification session type.

System_CAPS_pubpropertySmsId

Gets the client SMSID.

System_CAPS_protpropertySynchronizer

Gets the synchronizer object used for thread synchronization.

System_CAPS_pubpropertyValidateCrl

If true, the Certificate Revocation List (CRL) is verified.

System_CAPS_pubpropertyValidateServerCertificate

If true, the server certificate is valid.

NameDescription
System_CAPS_pubmethodCloseSession()

Closes an active client notification session. If the session is not open, no action is taken.

System_CAPS_pubmethodSystem_CAPS_staticCreateSession(BgbSessionType, String^, MessageSecurityMode, SmsClientId^, ClientVersionBase^, MessageCertificateX509^)

Creates a new client notification session of a specific type using the default port.

System_CAPS_pubmethodSystem_CAPS_staticCreateSession(BgbSessionType, String^, UInt16, MessageSecurityMode, SmsClientId^, ClientVersionBase^, MessageCertificateX509^)

Creates a new client notification session of a specific type.

System_CAPS_pubmethodDispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

System_CAPS_protmethodDispose(Boolean)

Implementation of IDisposable.

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodInternalCloseSession()

Closes a session.

System_CAPS_protmethodInternalOpenSession()

Opens a session with the client notification server.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnBgbMessageReceived(ConfigMgrBgbSessionEventArgs^)

Invokes the BgbMessageReceived event when a client notification message is received.

System_CAPS_protmethodOnBgbMessageSent(ConfigMgrBgbSessionEventArgs^)

Invokes the BgbMessageSent event when a client notification message is sent.

System_CAPS_protmethodOnBgbSessionClosed(EventArgs^)

Invokes the BgbSessionClosed event when a BGB session closes.

System_CAPS_protmethodOnBgbSessionOpened(EventArgs^)

Invokes the BgbSessionOpened event when a BGB session opens.

System_CAPS_pubmethodOpenSession()

Opens a client notification session using the parameters defined in the source message.

System_CAPS_protmethodProcessReceivedMessage(BgbMessageType, Stream^, UInt32, UInt32)

Internal handler for processing a received message.

System_CAPS_protmethodSendMessageImplementation(IMessage^, BgbMessageType)

Implementation for sending a message to a session listener.

System_CAPS_pubmethodSendResponseMessage(BgbResponseMessage^)

Sends a response message for a request over the BGB channel.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_protmethodValidate()

Performs message validation.

System_CAPS_protmethodValidate(Collection<Exception^>^)

Performs message validation.

NameDescription
System_CAPS_pubeventBgbMessageReceived

Invoked when a client notification message is received on the asynchronous channel.

System_CAPS_pubeventBgbMessageSent

Invoked when a client notification message is sent on the asynchronous channel.

System_CAPS_pubeventBgbSessionClosed

Invoked when a client notification session is closed.

System_CAPS_pubeventBgbSessionOpened

Invoked when a client notification session is successfully created.

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

Return to top
Show: