MFDpwsClient

Base class used by a dpws client applicaiton or control developer to implement a dpws device client. Dpws client implementations must derive from this class.

Creates an instance of a DpwsClient class.

Creates an instance of a DpwsClient class with a specified eventing callback port number.

This class is an internal callback method that provides DPWS compliant Hello discovery client services. An instance of this class will be created in the Init function. The stack runs a single service that handles Hello and Bye services.

Internal callback used by DpwsDiscoClient to update DpwsDiscoService when the ws-discovery version changes. The method deletes the current DpwsDiscoService from the listening services collection and ads a new one that when created will have the new disco versino information.

A DiscoVersion object containing the new ws-discovery version information.

Method used by the discovery callback methods to raise a Hello event

A HelloEventArgs object containing hello event details.

Method used by the discovery callback methods to raise a Bye event

A HelloEventArgs object containing hello event details.

Releases all resources used by the DpwsClients object and removes this instance from the list of stack service processes.

Stop tranport services and releases the managed resources used by this class.

True to release managed resources

A wrapper method that implements the ProcessRequest interface used to control blocking of request. The BlockingCall property is used by the stack to control single instance execution. Hello and Bye are not blocked. Event messages from a device are blocked. This means it is up to a client developer to insure long thread safety.

A WsWsaHeader containing the header proerties of a request. A WsXmlDocument containing the entire envelope of the message in a node tree. A byte array containing a soap response to the request.

SubscriptionEnd stub calls the eventing client SubscriptionEnd handler

A WsWsaHeader object containing the details soap header information. A WsXmlDocument object containing the the entire soap message. A byte array containig a soap response mesage.

Use to get an instance of a Dpws eventing client.

Use this property to access WS-Discovery methods.

Property containing an instance of a Dpws Discovery client.

Event property used to create and event handler for Dpws Hello messages.

Event property used to create an event handler for Dpws End messages.

Event property used to create an event handler for Ws-Eventing, SubscriptionEnd messages.

Property containing an instance of a Dpws Metadata client.

Use this property to access WS-Metadata exchange methods.

Property containing a collection of event sink callback methods.

Use this colleciotn to add or remove event operations (event handlers) for this client.

Use to Get or Set a collection used to store Mtom bodyparts.

If the transport services receive an Mtom request. This collection contains the body parts parsed from the Mtom message. If a client needs to send an Mtom request they can populate this collection and set the ResponseType property to WsResponseType.Mtom to tell the transport services to parse this collectionand return and Mtom formatted response message.

Property used to enable of disable receiving discovery request from this ip address.

Property used to get or set the local IPV4 address.

A urn:uuid used by the transport services to locate this client. This property represents the endpoint reference address of a client. This stack supports urn:uuid endpoint addresses only.

This property contains a unique endpoint reference address. The message dispatcher uses this address to route messages to methods implemented in a client at this address. The combined base transport address (http://ip_address:port/) and this property equal the Header.To property of messages directed to this client.

Property used to identify the type of message sent or received.

The type of messages supported by the stack are Soap, Mtom and Fault. See BodyParts description. The default value of this property is WsResponseType.Soap.

Property containing the port used to listen for events.

Read only property containing a Dpws compliant transport address.

The only transport address format supportd by this stack is: http://(device ip address):(device port)/(device.address - urn:uuid prefix)

Property that determines if ProcessRequest call blocks.

Class used to store a services type definition.

The information in this class represents a type encapsulated by a service. Service type information returned from a probe an resolve are stored in this class.

Use to get or set a service types namespace Uri.

Use to get or set the name of a service type.

Creates an instance of a DpwsEndpointType class.

Collection class used to store a list of DpwsServiceTypes objects.

This collection is thread safe.

Creates an instance of a DpwsServiceTypes collection class.

This collection is thread safe.

Adds a DpwsServiceType to the end of the collection.

The DpwsServiceType element to be added to the end of the collection. The value can be null. The collection index at which the DpwsServiceType has been added.

Removes all elements from the collection.

Removes the first occurrence of a specific DpwsServiceType from the collection.

The DpwsServiceType to remove from the collection. The value can be null.

Use to Get the number of DpwsServiceTypes elements actually contained in the collection.

Use to Get or set the DpwsServiceType element at the specified index.

The zero-based index of the DpwsServiceType element to get or set. An intance of a DpwsServiceType element. If index is less than zero.-or- index is equal to or greater than the collection count.

A class used to process client Probe and Resolve request.

Creates and instance of the DpwsDiscoveryClient class.

Sends a directed Probe request and parses ProbeMatches responses.

A string containing a Dpws devices transport endpoint address. For example: http://192.168.0.1:8084/3cb0d1ba-cc3a-46ce-b416-212ac2419b20 A string containing the target service address to probe for. For example: urn:uuid:3cb0d1ba-cc3a-46ce-b416-212ac2419b20 A DpwsServiceTypes object containing a collection of types a service must support to signal a match. Null = any type. A directed Probe is used to discover services on a network. The DirectedProbe method sends a HTTP request to the service specified endpointAddress parameter. A service at the endpoint that implements matching types specified in the filters parameter should respond with a ProbeMatches message. The ProbeMatches mesgage is returned as the response to the DirectedProbe request. If a null filter is supplied any Dpws complient service should reply with a ProbeMatches reponse. This method is used to directly ask for service endpoint information. A collection of ProbeMatches objects. A ProbeMatch object contains endpoint details used used to locate the actual service on a network and the types supported by the service. If a fault response is received.

Sends a directed Resolve request and parses ResolveMatch response.

A string containing a Dpws devices transport endpoint address. For example: http://192.168.0.1:8084/3cb0d1ba-cc3a-46ce-b416-212ac2419b20 A string containing the address of a service that will handle the resolve request. For example: urn:uuid:2bcdd1ba-cc3a-46ce-b416-212ac2419b20 A string containing the address of a service that can process the resolve request. For example: urn:uuid:3cb0d1ba-cc3a-46ce-b416-212ac2419b20 A Resolve is used to resolve the transport address of a know service. The request contains a service address aquired from configuration or a previous Resolve or Metadata Get request. The DirectedResolve method sends a Http request to the specified endpoint address. If the endpoint contains a device with this address receives the request, it must send a unicast ResolveMatches response back to the client that made the request. A collection of ResolveMatches objects. A ResolveMatch object contains endpoint details used used to locate the actual service on a network and the types supported by the service.

Sends a Probe request and parses ProbeMatches responses.

A DpwsServiceTypes object containing a collection of types a service must support to signal a match. Null = any type. A Probe is used to discover services on a network. The Probe method sends a UDP request to the Dpws multicast address, 239.255.255.250:3702. Any service that implements types specified in the filters parameter should respond with a ProbeMatches message. The ProbeMatches mesgage is unicast back to the that client that made the request. If a null filter is supplied any Dpws complient service should reply with a ProbeMatches reponse. Probe waits DpwsDiceoveryCleint.ReceiveTimout for probe matches. A collection of ProbeMatches objects. A ProbeMatch object contains endpoint details used used to locate the actual service on a network and the types supported by the service.

Sends a Probe request and parses ProbeMatches responses.

A DpwsServiceTypes object containing a collection of types a service must support to signal a match. Null = any type. An integer representing the maximum number of matches to reveive within the timout period. Pass 0 to receive as many matches as possible before the timeout expires. An integer specifying a request timeout in milliseconds. Pass -1 to wait ReceiveTimeout. A Probe is used to discover services on a network. The Probe method sends a UDP request to the Dpws multicast address, 239.255.255.250:3702. Any service that implements types specified in the filters parameter should respond with a ProbeMatches message. The ProbeMatches mesgage is unicast back to the that client that made the request. If a null filter is supplied any Dpws complient service should reply with a ProbeMatches reponse. Probe waits DpwsDiceoveryCleint.ReceiveTimout for probe matches. A collection of ProbeMatches objects. A ProbeMatch object contains endpoint details used used to locate the actual service on a network and the types supported by the service.

Builds a probe request message based on the filters parameter.

A string containing the target service address. For example: urn:uuid:3cb0d1ba-cc3a-46ce-b416-212ac2419b20 A DpwsServiceTypes object containing a collection of types a service must support to signal a match. Null = any type. A string used to return the messageID assigned to this message. A byte array containing the probe message or null if an error occures.

Send a Resolve request to a specific service endpoint.

A string containing the target service address of a known service. For Dpws this address would represents a devices address. For example: urn:uuid:3cb0d1ba-cc3a-46ce-b416-212ac2419b20 A Resolve is used to resolve the transport address of a know service. The request contains a service address aquired from configuration or a previous Probe or Metadata Get request. The Resolve method sends a UDP request to the the Dpws multicast address, 239.255.255.250:3702. If a device with this address receives the request, it must send a unicast ResolveMatches response back to the client that made the request. A collection of ResolveMatches objects. A ResolveMatch object contains endpoint details used used to locate the actual service on a network and the types supported by the service.

Send a Resolve request to a specific service endpoint.

A string containing the target service address of a known service. For Dpws this address would represents a devices address. For example: urn:uuid:3cb0d1ba-cc3a-46ce-b416-212ac2419b20 An integer specifying a request timeout in milliseconds. Pass -1 to wait ReceiveTimeout. A Resolve is used to resolve the transport address of a know service. The request contains a service address aquired from configuration or a previous Probe or Metadata Get request. The Resolve method sends a UDP request to the the Dpws multicast address, 239.255.255.250:3702. If a device with this address receives the request, it must send a unicast ResolveMatches response back to the client that made the request. A collection of ResolveMatches objects. A ResolveMatch object contains endpoint details used used to locate the actual service on a network and the types supported by the service.

Builds a probe request message based on the filters parameter.

A string containing the target service address of a known service to resolve. For example: urn:uuid:3cb0d1ba-cc3a-46ce-b416-212ac2419b20 A string containing the address of a service endpoint used to process the resolve request. For example: urn:uuid:22d0d1ba-cc3a-46ce-b416-212ac2419b20 A string reference used to store retreive the messageID from resolve message generation. The id is used to verify probe match responses for ad-hoc operation. A byte array containing the resolve message or null if an error occures.

Use to send a resolve request to the ws-discovery address and receive a resolve match.

A byte array containing a the resolve message. A string containing the message ID of a resolve request. This ID will be used to validate against a ResolveMatch received if it don't match, the ResolveMatch is discarded. A DateTime value containing the length of time this request will wait for resolve match. until the timeout value has expired. A resolve match object.

Use to get or set the UDP discovery port that this client listens for discovery responses on.

Use to get or set the time in milliseconds that a probe or resolve listener should wait for probe matches.

Use to set the Discovery version

Abstract base Ws-Discovery version class

Use to get or set the Ws-Discovery version number.

Use to get or set the Ws-Discovery Well Know Address.

Derived class used to store Ws-Discovery version 1.0

Get the Ws-Discovery version number.

Use to get the Ws-Discovery Well Know Address.

Derived class used to store Ws-Discovery version 1.1

Get the Ws-Discovery version number.

Use to get the Ws-Discovery Well Know Address.

Base class used by DpwsProbeMatch and DpwsResolve match classes.

This base class contains target service endpoint properties that identify a services supported types and endpoint address.

Creates an instance of a DpwsServiceDescription class initialized with a service endpoint and a list of supported service types.

A WsWsaEndpointRef object containing a Dpws Device servie endpoint. A string array containing a list of service types supporte by a Dpws devie service endpoint.

Use to get a WsWsaEndpointRef contining the endpoint of a service that supports types requested in a probe match.

Use to get the metadata version of the probe match object.

Use to get a list of types supported by a device.

Use to get an array containing transport specific endpoint addresses representing a services physical endpoint address. This is an optional ws-discovery parameter.

A base collection class used to store DpwsServiceDescription objects.

DpwsProbeMatches and DpwsResolveMatches derive from this base collection. This class is thread safe.

Creates an instance of a DpwsServiceDescriptions collection.

Adds a DpwsServiceDescription to the end of the collection.

The DpwsServiceDescription element to be added to the end of the collection. The value can be null. The collection index at which the DpwsServiceDescription has been added.

Removes all elements from the collection.

Determines whether an instance of a specified DpwsServiceDescription is in the collection.

The DpwsServiceDescription to locate in the collection. The value can be null. True if DpwsServiceDescription is found in the collection; otherwise, false.

Searches for a DpwsServiceDescription by endpoint address and returns the zero-based index of the first occurrence within the entire collection.

The endpoint address of the DpwsServiceDescription to locate in the collection. The zero-based index of the first occurrence of DpwsServiceDescription within the entire collection, if found; otherwise, -1.

Use to Get the number of DpwsServiceDescription elements actually contained in the collection.

Use to Get or set the DpwsServiceDescription element at the specified index.

The zero-based index of the DpwsServiceDescription element to get or set. An intance of a DpwsServiceDescription element. If index is less than zero.-or- index is equal to or greater than the collection count.

This class contains methods that process Ws-Discovery messages. Discovery response messages are passed to these methods where they are parsed into discovery objects used by client implementations.

Creates an instance of a DpwsDiscoClientProcessor class.

Parses a ProbeMatches message.

A byte array containing a probe response soap message. A string containing the message ID of the original request. This is used to make insure this is a response to the original request. A IPEndPoint containing the remote address of the service that sent this response. A WsMessageCheck object ued to test for a duplicate request message. If null no check is performed as would be the case for a directed probe response. A DpwsProbeMatch object containing a service endpoint description returned by a service. If required tags are missing or invalid namespaces are detected.

Parses a ResolveMatches message.

A byte array containing a resolve response soap message. A string containing the message ID of the original request. This is used to make insure this is a response to the original request. A IPEndPoint containing the remote address of the service that sent this response. A WsdMessageCheck object ued to test for a duplicate request message. If null no check is performed as would be the case for a directed probe response. A DpwsResolveMatch object containing a service endpoint description returned by a service. If required tags are missing or invalid namespaces are detected.

Parses a GetResponse message.

A byte array containing a response message. The message ID sent in the original request. A DpwsMetadata object containing a details about a service endpoint.

A delegate used by the discovery client Hello event handler.

The object that raised the event. An object that contains the endpoint address, types, xaddr and metadataversion of a hello request.

A delegate used by the discovery client Bye event handler.

The object that raised the event. An object that contains the endpoint address and xaddr of a bye request.

A WsWsaHeader containing the header proerties of a request. A WsXmlDocument containing the entire envelope of the message in a node tree. A byte array containing a soap response to the request.

Hello stub calls the client hello handler

A WsWsaHeader object containing the details soap header information. A WsXmlDocument object containing the the entire soap message. A byte array containig a soap response mesage.

Bye stub calls the client Bye handler

A WsWsaHeader object containing the details soap header information. A WsXmlDocument object containing the the entire soap message. A byte array containig a soap response mesage.

Property that determines if ProcessRequest call blocks.

Use to Get or Set a collection used to store Mtom bodyparts.

Property containing a collection of exposed methods implemented by this target service.

Use this colleciotn to add or remove event operations (event handlers) for this client.

A urn:uuid used by the transport services to locate this client. This property represents the endpoint reference address of a client. This stack supports urn:uuid endpoint addresses only.

Property used to identify the type of message sent or received.

The type of messages supported by the stack are Soap, Mtom and Fault. See BodyParts description. The default value of this property is WsResponseType.Soap.

Subscribe method parameter class.

This class contains proerties used when subscribing to events.

Creates an instance a DpwsSubscribeRequest class initialized with the service endpoint Address, notifyTo callback endpoint address and event duration.

A DpwsServieType object containing a definition of the service being subscripbed to. A string containing an event source endpoint address. A string containing the notifyTo endpoint address. A string containing the subscription expiration time in duration format. If null the event does not expire. A WsWsaRefParamter object containing a unique identifier. This value will be included in an event messages soap header as a reference parameter. This value is not processed by a service it is intended to provide a unique identified a client can use for any purpose. This constructor sets the endTo address to null indicating that the notifyTo address should receive subscription end messages. A user ID for the event is not set by default. If duration format is invalid.

Property containing a DpwsServiceType object that defines the event service type of the subscription.

A property containing the endpoint address of a device service that exposes the event source you want to subscribe to.

The endpoint address must contain an http Uri for the service that exposes the event. This address must contain an ip address of the device that contains the service and the service id or the service that contains the event source (i.e. http://ip_address:port/service_id_guid).

A property containing an endpoint reference that specifies where the service is to send an event. The address field of the endpoint reference must contain an http Uri that defines an ip address and a guid that specifies a unique endpoint of an event sink that will handle the request. User defined reference properties and parameters can be added to this endpoint.

A property containing an endpoint reference that specifies where the service is to send subscription end events. The address field of the endpoint reference must contain an http Uri that defines an ip address and a guid that specifies a unique endpoint of an event sink that will handle the request. User defined reference properties and parameters can be added to this endpoint. If this proerty is null the service will send subscription end notifications to the notifyTo address.

A property contining the desired duration of a subscription. The service may assign a different value. This stack supports duration formats only.

Dpws event subscription class.

Creates an instance of a DpwsEventSubscription class.

Property used to store the Expires duration returned from a subscribe request. The value may be different that the expiration time sent in te original request.

A property containing a uniue identifier assigned by the subscription manager for this event. This ID is required for later unsubscribe, renew and get status request.

Property used to store the endpoint reference of the subscription manager.

Class used by a Dpws client to control device event subscriptions.

A DPWS client uses this class to subscribe to, Unsubscribe from, Renew a subscription to and get the status of an event subscription.

Creates an instance of a DpwsEventingClient class.

Use to subscribe to a devices, hosted service event sources.

A DpwsSubscriptionRequest object containing the address of the service hosting the desired event, the address where the event is sent, an optional address where subscription end messages are sent, A subscription expiration (in duration format) and an optional user defined identifier. A DpwsEventSubscription containing the the subscription managers address, the time when the subscription expires (duration) and optional reference parameters and properties. Per spec the sub mananger may assign a different duration value than that specified in the request. If required subscription parameters are not set.

Method parses an event subscription response and returns the duratoin returned in the response.

A byte array containing a subscribe response message. A string containing the original message ID passed in the request. This id is used to validate that this is a response to the original request. A DpwsEventSubscription object containing the expiration time actually set by a subscription manager. If parsing errors are detected. If a fault response is received.

Method used to write an endpoint reference and reference parameters or properties.

An XmlWriter used to write the endpoint reference. A WsWsaEndpointRef containing the information to write.

Use to unsubscribe from a devices event source.

A Uri containing the endpoint address of the service or subscription manager that is currently maintaining this event subscription on behalf of the device. This address is an http uri (i.e. http://ip_address:port/serviceID). An event subscription returned from a previous subscribe call. The subscription contains among other things a subscription ID used by the subscription manager to identify a specific event source subscription and the endpoint address of the subscription manager. True if the Unsubscribe request was successful.

Method parses an unsubscribe response and returns.

A byte array containing an unsubscribe response message. A string containing the original message ID passed in the request. This id is used to validate that this is a response to the original request. True is parsing is successful. If header or envelope parsing fails, If a required message tag is missing or an invalid or missing namespace is found.

Use to renew an existing subscription.

A Uri containing the endpoint address of the service or subscription manager that is currently maintaining this event subscription on behalf of the device. This address is an http uri (i.e. http://ip_address:port/serviceID). A subscription ID returned from a previous subscribe response. The device uses this ID to identify a specific event source subscription. A WsDuration object indicating the new duration time for this event subscription, null = infinite. A WsDuration object containing the new Expires time actually asigned by the device service to this event subscription, null = infinite.

Method parses a subscription renewal response and returns.

A byte array containing a renew response message. A string containing the original message ID passed in the request. This id is used to validate that this is a response to the original request. A WsDuration object containing the new expiration time for the event. If header or envelope parsing fails, If a required message tag is missing or an invalid or missing namespace is found.

Use to get the status of an event subscription.

A Uri containing the endpoint address of the service or subscription manager that is currently maintaining this event subscription on behalf of the device. This address is an http uri (i.e. http://ip_address:port/serviceID). A subscription ID returned from a previous subscribe response. The device uses this ID to identify a specific event source subscription. A WsDuration object containing the remaining subscription time for this event subscription, null = infinite.

Type used to define a set of parameters passed to a SubscriptionEnd event handler.

The endpoint address of the subscription manager that sent the subscription end request.

Client defined identifier.

A string containing a subscription ID that identifies an event source.

Create an instance of a SubscriptionEndEvent arguments object.

A delegate used by the eventing clients SubscriptionEnd event handler.

The object that raised the event. An object that contains subscription end details.

Used to get a Dpws services metadata.

Creates an instance of a DpwsMexClient class.

Use to request metadata from a devices hosted service endpoint.

A string containing the transport address of a service endpoint. For Dpws the address represents a devices transport address. For example: http://192.168.0.1:8084/3cb0d1ba-cc3a-46ce-b416-212ac2419b20 A collection of DpwsMetadata objects containing endpoint details about services hosted by a device.

Class used to store a devices ThisModel information.

Name of the manufacturer of a device.

Must have fewer than MAX_FIELD_SIZE characters.

Url to a Web site of the manufacturer of a device.

Must have fewer than MAX_URI_SIZE octets.

User friendly name for a model of device.

Must have fewer than MAX_FIELD_SIZE characters.

Model number for a model of device.

Must have fewer than MAX_FIELD_SIZE characters.

URL to a Web site for a model of device.

Must have fewer than MAX_URI_SIZE octets.

URL to an Html page for a device.

Must have fewer than MAX_URI_SIZE octets.

A class used to store a devices ThisDevice metadata.

User-friendly name for a device.

Must have fewer than MAX_FIELD_SIZE characters.

Firmware version for a device.

Must have fewer than MAX_FIELD_SIZE characters.

Manufacturer assigned serial number for a device.

Must have fewer than MAX_FIELD_SIZE characters.

A class used to store Relationship metadata.

A collection used to store metadata Relationship Hosted Service objects.

Used to store a metadata Relationship service Host object.

Base class used to store metadata service information about a host or Hosted service.

A collection of service types.

A Uri containing a services transport address.

A string containing a services ID.

A collection of DpwsMexServices metadata elements.

This class is used by DpwsMetadata to store a collection of DpwsMexServices objects. DpwsMexServices objects contain details about a hosted service endpoint.

Creates an instance of a DpwsMexServices class.

Adds a DpwsMexServices to the end of the collection.

The DpwsMexServices element to be added to the end of the collection. The value can be null. The collection index at which the DpwsMexServices has been added.

Removes all elements from the collection.

Use to Get the number of DpwsMexServices elements actually contained in the collection.

Use to Get or set the DpwsMexServices element at the specified index.

The zero-based index of the DpwsMexServices element to get or set. An instance of a DpwsMexServices element. If index is less than zero.-or- index is equal to or greater than the collection count.

Used to store service endpoint metadata details aquired from a Get metadata response.

Creates an instance of a DpwsMetadata class.

Use to get an object containing model specific information for the device this metadata object contains.

Use to get an object containing device specific information for the device this metadata object contains.

Class used to send and receive http messages. Dpws clients use this class to send and receive messages to and from a devices hosted services.

Creates an instance of an DpwsHttpClient class.

Method used to send a soap request over http to a service endpoint.

A byte array contining a soap request message. A string containing the endpoint address of a service that will receive the request. This must be a transport address in the format http://ip_address:port/service_address. True = don't wait for response, false means wait for a response. If true true the message will be chunk encoded. A DpwSoapResponse object containing a WsWsaHeader and a XmlReader or null if no response is received or parsing fails.

Method used to send a soap request over http to a service endpoint.

A byte array contining a soap request message. A string containing the endpoint address of a service that will receive the request. This must be a transport address in the format http://ip_address:port/service_address. True = don't wait for response, false means wait for a response. If true true the message will be chunk encoded. If not null contains parameters required to fix up the http header for mime multipart. WsMessage object containing the soap response returned from a service endpoint.

Use to get or set the time in milliseconds this client will wait for a remote endpoint connection. The defaule value is 45000 or 45 seconds.

Use to get or set the time in milliseconds that this client will wait for a response from a remote endpoint. The default value is 45000 or 45 seconds.

Class contains a header and envelope object parsed from a soap response message. This object is returned by the SendRequest method.

Creates an instance of a DpwsSoapResponse class initialized with a header and envelope objects.