MFDpwsDevice
Creates a device used to manage global device information, host and hosted services.
The Device class provides the base functionality of a device. It is the primary control class
for a device and is the container and manager of hosted services provided by a device. This class exposes
static methods and properties used to manage device information, start and stop internal services
and manage hosted services.
A device developer uses this class to set device specific information common to all hosted services
like ThisModel, ThisDevice and endpoint informaton like the device address and device id. When
developing hosted services this class provides access to information required by the service
when building response messages. The device class also manages a collection of hosted services
that implement the functionality of a device.
Hosted services are created by device developers. These services are added to the collection
of hosted services maintained by the device class. When the device services, start an instance
of each hosted service in the hosted services collection is instantiated. When a device request is
received the hosted services collection contains information used by the transport services
to route request to a specific service.
The device class also manages a set of internal hosted services that provide the boiler plate
functionality of DPWS Device Profile for Web Services) like Discovery, Mex and the Event Subscription
manager. As mentioned these are boiler plate services and are therefore not exposed to a device
developer.
The device class also manages a collection of namespaces common to all DPWS compliant devices.
If a device requires Host functionality outlined in the DPWS specification a hosted service can be
added to the device to provide this functionality. Special provisions are made because a devices
Host service has the same endpoint as the device.
This class is an internal hosted service that provides DPWS compliant WS-Discovery Probe and Resolve
service endpoints.
This class is an internal hosted service that provides DPWS compliant WS-Transfer (Metadata Exchange) services.
Use this static property if the device requires a Host relationship, create a hosted service that
implements device specific host funcitonality and assign it to the Host property.
The Host, hosted service will have the same endpoint address as the device.
Field used to access an event subscription manager. The subscription manager provides event
subscription functionality required to fire events from a hosted service.
Initializes the device. This method builds the colletion of internal device services, sets
the devices transport address and adds DPWS required namespaces to the devices namespace collection.
Method used to Start the stack transport services.
The Start Method initialises device specific services and calls the stack services to start
the Http and UDP transport services. It also creates and starts an instance of the
Event Queue manager service that manages event subscription expirations.
Static method used to stop stack transport services.
This method stops the underlying stack transport services and the devices event queue manager.
Initializes the App Sequence value.
An In32 containing the app sequence number.
Property used to determine if device services are running.
Collection property used to add hosted services to this device. Hosted services implement device
specific services and derive from DpwsHostedService.
Property useed to set the maximum number of threads used to process Http request. Default value is 5.
Use this as a tuning parameter and be conservative.
Property useed to set the maximum number of threads used to process Udp (Discovery) request. Default value is 5.
Use this as a tuning parameter and be conservative.
Property containing the maximum wait time for a probe match message response.
The default value is 500 ms. as per Dpws specification. Set this value to 0 if implementing
a discovery proxy. See Ws-Discovery specification for details.
Set this property to true to ignore disco request from the same ip address as the device.
Property contining the IPV4 address of this device.
Property containing the http listener port number.
Static property used to Get or Set a devices DPWS compliant Metadata version.
If a device changes any of it's relationship metadata, it Must increment the Metadata Version exposed
in Hello, ProbeMatch and ResolveMatch soap messages. The device metadata relationship is considered to
be static per metadata version.
Static property containing a Dpws compliant endpoint address.
This stack supports urn:uuid:(guid) format addresses only.
Static property used to Get a devices DPWS compliant transport address.
The transport address format supportd by this stack is:
http://(device ip address):(device port)/(device.address - urn:uuid prefix)
Static property used to Get the required WS-Discovery App Sequence value.
This is a soap header value and is required by WS-Discovery to facilitate ordering of Hello and
Bye messages. This stack uses the App Sequence request and response messages. In addition to the
Ws-Discovery Hello/Bye requirements this stack includes the AppSequence element in all WS-Discovery
messages.
Static property used to Get or Set the DPWS compliant MessageID value.
This is a soap header value and is required in DPWS compliant request and response messages.
This stack uses this property to match a response with a request.
This property is thread safe.
Static property used to turn adhoc discovery on or off. Adhoc disco is optional with a Discovery Proxy.
Use to set the Discovery version
This class stores model specific information about a device.
Name of the manufacturer of this device.
Must have fewer than MAX_FIELD_SIZE characters.
Url to a Web site of the manufacturer of this device.
Must have fewer than MAX_URI_SIZE octets.
User friendly name for this model of device.
Must have fewer than MAX_FIELD_SIZE characters.
Model number for this model of device.
Must have fewer than MAX_FIELD_SIZE characters.
URL to a Web site for this model of device.
Must have fewer than MAX_URI_SIZE octets.
URL to an Html page for this device.
Must have fewer than MAX_URI_SIZE octets.
This class stores device specific information about a device.
User-friendly name for this device.
Must have fewer than MAX_FIELD_SIZE characters.
Firmware version for this device.
Must have fewer than MAX_FIELD_SIZE characters.
Manufacturer assigned serial number for this device.
Must have fewer than MAX_FIELD_SIZE characters.
This class implements a set of base methods and properties used by the stack to dispatch method
calls and discover hosted service endpoints, operations and events. A Device developer must derive
their hosted service class(es) from this base class.
A default namespace and perfix are provided. Set the EndpointAddress property to change default values.
Creates and instance of the HostedService class.
Adds an endpoint reference to the hosted services collection.
This endpoint refernce will be used by the devices discovery services to expose the endpoint
of this service.
A string containing the urn:uuid that uniquely defines this service.
A wrapper method that implements the ProcessRequest interface used to control blocking of request.
Standard stack services are static and do not require blocking. Hosted service are blocked.
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.
Implements the IWsServiceEndpoint.ProcessRequest method.
Gets a service operation based on the action property sent in the soap header and calls
invoke on the service method.
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.
Eventing Subscribe stub.
Header object.
An XmlReader positioned at the begining of the Subscribe request body element.
Byte array containing a Subscribe response.
This method is used by the stack framework. Do not use this method.
Eventing UnSubscribe stub.
Header object.
An XmlReader positioned at the begining of the Unsubscribe request body element.
Byte array containing an UnSubscribe response.
This method is used by the stack framework. Do not use this method.
Event renew stub.
Header object.
An XmlReader positioned at the begining of the Renew request body element.
Byte array containing an Renew response.
This method is used by the stack framework. Do not use this method.
Event GetStatus stub.
Header object.
An XmlReader positioned at the begining of the GetStatus request body element.
Byte array containing an GetStatus response.
This method is used by the stack framework. Do not use this method.
Iterates a collection of event sources an looks for an event sink by ID.
A collection of event sources.
An event sink ID.
An event sink object if found otherwise null.
Use to Get or Set a collection of endpoint references specific to a device implementation.
This property is used by a devices internal services like Discovery and Eventing to ease in the
processing of service endpoint information.
Use to Get or Set a collection used to store Hosted Services operations parameters like Action and namespace.
Use to Get or Set a collection used to store Event Source parameters like event source name and namespace.
An Event Source is used to expose event source endpoints implemented by a hosted service. A DPWS client
application can subscribe to events exposed as event sources. Each hosted service event capable
of firing a message to a client must store an event source in this collection. A device developer creates
and Event Source object for an event and used the Add method of this object to add the event source
to the hosted services event sources collectino. See DpwsWseEventSources for detials on the Add method.
Each event source entry contains a collection of event sinks that have an active subsrciption to an event.
Event Sinks contain information about a clients endpoint.
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 device devloper needs to send an Mtom response 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.
Use to get or set the type of response message a HostedService is sending to a client.
See BodyParts description. The default value of this property is WsMessageType.Soap.
Use to Get or Set a string representing the name of a hosted service.
This name represents the type(object) name of this hosted service. This name is used by the
device stacks discovery services to provide a type name presented
in a ProbeMatch or Metadata Get response.
Use to Get or Set the namespace for a HostedService.
It is strongly recommeded that a device developer sets this namespace however if a namespace
is not set a default namespace is generated. The default namespace will have a prefix of S(x) and
the namespace URI will be generated using the name of derived hosted service class.
Use to Get or Set a unique identifier for the hosted services.
This is the unique identifier for a hosted service which must be persisted across
re-initialization and must be shared across multiple hosted elements.
A hosted service ID must be unique within a device. This value will be compared directly
as a case sensitive string. This stack supports urn:uuid:GUID values for service id only.
A device developer must set this property. This property is sent is a Get metadata response
and used by a DPWS client to identify a specific service within a device.
The unique endpoint address used by the HTTP transport to access this hosted service.
This property makes up the unique portion of a hosted service endpoint address. The stack automatically
gererates http transport endpoint addresses using this property. The generated endpoint address
will be used by DPWS clients to call this hosted service. In a directed soap request the http
transport that incorporates this address will be sent in the header.To property. The transport
dispatcher uses the http transport address to dispatch a request to the intended hosted service.
By default this property is set to the ServiceID. It is highly recommended you do not set this
value manually. By default the stack generates a unique http transport address using the following
format: HTTP://(device ip address):(deviceport):/(SericeAddress). If you set this property the
stack will use your address in place of the (ServiceAddress) portion. If you set it make sure
you know what you intend to do or your request will not make it to the service. When this property
is set an endpoint reference is created and added to the endpoint references collection for this
service. See AddEndpoints for more information.
Property that determins if the ProcessRequest call blocks.
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.
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.
Discovery client used to send managed Hello and Bye messages
Method used to send an http Hello message to specified endpoint. Use for managed discovery.
A string containing the endpoint address of a listening client.
Method used to send an http Bye message to specified endpoint. Use for managed discovery.
A string containing the endpoint address of a listening client.
Discovery client used to send Hello and Bye messages
Method used to send Hello and Bye messages
An integer representing the type of greeting 0 = Hello, 1 = Bye.
Use this class to store information that identifies a specific hosted service event source.
You must create an DpwsWseEventSource object for each event in a hosted service you want
to expose to a DPWS client. The event source object must then be added to the hosted service
event source collection to register it with the device services. When a client subscribes
to an event the subscription manager uses this class to validate and create an event subscription
for the event source. The properties of this class represent the event type in an event
subscription request.
Creates an instance of the event source class.
The event source namespace prefix.
The event source namespace Uri.
The event source type name.
Use to Get the name of the event source.
Use to Get the event source namespace prefix.
Use to Get the event source namespace Uri.
Use to get the complete event source namespace qualified name.
A collection of a hosted services event sources.
A device developer uses this collection to manage event sources in their there hosted service.
Creates an instance of the event sources collection.
Adds an event source to the end of the event source collection.
The event source object to be added to the end of the event sources collection. The value can be null.
The event source index at which the value has been added.
Gets the number of event sources actually contained in the eventsource list.
Gets or sets the event source at the specified index.
The zero-based index of the event source to get or set.
The event source at the specified index.
This class manages event subscription expirations. A thread runs that monitors a collection of event sinks.
When an event subscrition for the event sink expires, this class removes the event from the collectionn.
Creates an instance of the DpwsWseEventSinkQManager class.
Method used to start the event subscription monitoring process.
Method used to stop the expiration manager thread
Method used to expire events and send EndTo notification to an event sink
Use to raise a hosted service event to active event sinks.
The device stack uses this class to manage event subscriptions. A device developer uses this class to
send an event message to clients that have an active event subscription with an event source.
Creates an instance of the Subscription manager class.
The device manages an instance of this class on behalf of the device. A device developer
must use the static Device.SubScriptionMgr.FireEvent method to fire events from an event
source.
Use this method to raise an event.
The hosted service that contains the event source.
The event source that define the event.
The event message buffer.
A device developer is responsible for building the event message buffer sent
to clients that have an active event subscription with an event source. The subscription manager
uses the hosted service parameter to access various properties of the service. The event source
parameter is used to access the event sinks collection of the event source. Note: This method
requires special provisions in order to properly build event message headers for each event sink.
In order to send an event to a listening client the soap.header.To property must be changed for
each listening client. In the future custom attribute support will solve this problem. For now
however a search and replace mechanism is used to modifiy the header.To property. When a device
developer builds the event message buffer they must use the search string WSDNOTIFYTOADDRESS for
the To header property.
Called by for each active event sink to send an event message to a listening client.
Byte array containing the event message soap envelope.
Used by the subscription manager to send a subscription end message to a listening client.
An event sink object containing the client endpoint information.
A string that specifies the reason fot the subscription end.
A id used by the client to identify this subcription.
If an error occures when sending an event message this method is called to tell
the client this subscription has been expired.
This method build a subscription end message.
An event sink containing client endpoint information.
A string containing reason why the subscription is ending.
An id sent by the client that they use to reference a subscription.
Service endpoints are stored as urn:uuid's. This method is used to convert the header.To address into
urn:uuid format if it is not already.
A string containing the header.To address.
A string containing a urn:uuid parsed from the header.To field.
Global eventing Subscribe stub.
Header object.
An XmlReader positioned at the begining of the Subscribe request body element.
A Collection of serviceEndpoints used to determine what services contain the event source specified in the filter.
Byte array containing a Subscribe response.
Eventing UnSubscribe stub.
Header object.
An XmlReader positioned at the begining of the Unsubscribe request body element.
A Collection of serviceEndpoints used to determine what services contain the specified event.
Byte array containing an UnSubscribe response.
This method is used by the stack framework. Do not use this method.
Event renew stub.
Header object.
An XmlReader positioned at the begining of the Renew request body element.
A Collection of serviceEndpoints used to determine what services contain the specified event.
Byte array containing an Renew response.
This method is used by the stack framework. Do not use this method.
Event GetStatus stub.
Header object.
An XmlReader positioned at the begining of the GetStatus request body element.
A Collection of serviceEndpoints used to determine what services contain the specified event.
Byte array containing an GetStatus response.
This method is used by the stack framework. Do not use this method.
Iterates a collection of event sources an looks for an event sink by ID.
A collection of event sources.
An event sink ID.
An event sink object if found otherwise null.