DicomObjects.NET.8.48 Documentation
DicomObjects.DicomWeb Namespace / DicomWebServer Class / Configure Method
An web server configuration object to do the listening
The uri on which the server will be listening - this is only used for creating "links" as the user is responsible for actually listening on that URL - see remarks
The prefix to be used for STOW operations
The prefix to be used for QIDO operations
The prefix to be used for WADO operations
The prefix to be used for Worklist operations
The prefix to be used for bul data retrieval






In This Topic
    Configure Method
    In This Topic
    Configure a web server to handle DicomWeb
    Syntax
    'Declaration
     
    
    Public Sub Configure( _
       ByVal Configuration As System.Web.Http.HttpConfiguration, _
       ByVal BaseUri As System.String, _
       ByVal StowPrefix As System.String, _
       ByVal QidoPrefix As System.String, _
       ByVal WadoPrefix As System.String, _
       ByVal WorklistPrefix As System.String, _
       ByVal BulkPrefix As System.String _
    ) 
    'Usage
     
    
    Dim instance As DicomWebServer
    Dim Configuration As System.Web.Http.HttpConfiguration
    Dim BaseUri As System.String
    Dim StowPrefix As System.String
    Dim QidoPrefix As System.String
    Dim WadoPrefix As System.String
    Dim WorklistPrefix As System.String
    Dim BulkPrefix As System.String
     
    instance.Configure(Configuration, BaseUri, StowPrefix, QidoPrefix, WadoPrefix, WorklistPrefix, BulkPrefix)
    public void Configure( 
       System.Web.Http.HttpConfiguration Configuration,
       System.string BaseUri,
       System.string StowPrefix,
       System.string QidoPrefix,
       System.string WadoPrefix,
       System.string WorklistPrefix,
       System.string BulkPrefix
    )
    public procedure Configure( 
        Configuration: System.Web.Http.HttpConfiguration;
        BaseUri: System.String;
        StowPrefix: System.String;
        QidoPrefix: System.String;
        WadoPrefix: System.String;
        WorklistPrefix: System.String;
        BulkPrefix: System.String
    ); 
    public function Configure( 
       Configuration : System.Web.Http.HttpConfiguration,
       BaseUri : System.String,
       StowPrefix : System.String,
       QidoPrefix : System.String,
       WadoPrefix : System.String,
       WorklistPrefix : System.String,
       BulkPrefix : System.String
    );
    public: void Configure( 
       System.Web.Http.HttpConfiguration* Configuration,
       System.string* BaseUri,
       System.string* StowPrefix,
       System.string* QidoPrefix,
       System.string* WadoPrefix,
       System.string* WorklistPrefix,
       System.string* BulkPrefix
    ) 
    public:
    void Configure( 
       System.Web.Http.HttpConfiguration^ Configuration,
       System.String^ BaseUri,
       System.String^ StowPrefix,
       System.String^ QidoPrefix,
       System.String^ WadoPrefix,
       System.String^ WorklistPrefix,
       System.String^ BulkPrefix
    ) 

    Parameters

    Configuration
    An web server configuration object to do the listening
    BaseUri
    The uri on which the server will be listening - this is only used for creating "links" as the user is responsible for actually listening on that URL - see remarks
    StowPrefix
    The prefix to be used for STOW operations
    QidoPrefix
    The prefix to be used for QIDO operations
    WadoPrefix
    The prefix to be used for WADO operations
    WorklistPrefix
    The prefix to be used for Worklist operations
    BulkPrefix
    The prefix to be used for bul data retrieval
    Remarks

    The actual coordination with the web interface is handled by the Configuration object, and this must therefore by created (either in conjunction with a web server, or self-hosting) and must listen on the stated URL, using code like this

    string BaseUri = "http://localhost:81/dicom"; HttpSelfHostConfiguration config = new HttpSelfHostConfiguration(BaseUri); server.Configure(config, BaseUri, "stow", "qido", "wado", "bulk"); server.StowReceived += Server_StowReceived; server.QidoReceived += Server_QidoReceived; server.WadoReceived += Server_WadoReceived; listen = new HttpSelfHostServer(config); listen.OpenAsync().Wait();

    The prupose of the BaseUri parameter is simply to provide the details needed for "back links" in bulk data URIs and WADO resposnses

    The prefixes used for the individual services are appended to that base URI as necessary, and are used for the configuration

    Requirements

    Target Platforms: .NET CLR 4.8 or higher

    See Also