IGLib  1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
IG.Web.WSBaseClass Class Reference

Base class for IGLib webservices. More...

+ Inheritance diagram for IG.Web.WSBaseClass:
+ Collaboration diagram for IG.Web.WSBaseClass:

Public Member Functions

virtual string GetServiceName ()
 Returns name of the web service. More...
 
virtual void SetServiceName (string name)
 Sets name of the web service. More...
 
void SetOutputLevel (int level)
 Sets the level of output generated by the service. More...
 
int GetOutputLevel ()
 Returns the current level of output generated by the service. More...
 
string TestService ()
 Tests whether the web service is alive. More...
 
string TestServiceCmd (string commandlineArguments)
 Tests whether the web service is alive. More...
 
string TestServiceArgs (string[] commandlineArguments)
 Tests whether the web service is alive. More...
 
string TestCount ()
 Web service method example. Increments a static counter. More...
 

Public Attributes

const string DefaultNamespace = "http://www2.arnes.si/~ljc3m2/igor/iglib/"
 

Static Public Attributes

static string VarNameOutputLevel = "OutputLevel"
 

Static Protected Member Functions

static int GetNextId ()
 Returns a new ID for a web service object. More...
 

Protected Attributes

string _url
 
CookieContainer _cookieContainer
 
const int CacheDurationTimeBase = 10
 
int _id = GetNextId()
 
const string VarNumTestCalls = "NumTestCalls__IGLib_Service_Base"
 

Static Protected Attributes

static string _namespace = DefaultNamespace
 
static int _nextId = 0
 
static string _name
 
static int _testCount
 

Properties

virtual string Url [get, set]
 URL of the web service. More...
 
virtual CookieContainer CookieContainer [get, set]
 Cookie container, for compatibility with proxy classes that are derived from the System.Web.Services.Protocols.HttpWebClientProtocol class. More...
 
static string NameSpace [get, set]
 
static int NextIdToBeAssigned [get]
 Returns the next service object ID to be assigned. More...
 
virtual int Id [get, protected set]
 
object Lock [get]
 Object used for locking of the current object. More...
 
int OutputLevel [get, set]
 Internal flag indicating the level of output the current object generates (e.g. output to the console). More...
 
- Properties inherited from IG.Web.IWSBase
string Url [get, set]
 URL of the web service. More...
 
System.Net.CookieContainer CookieContainer [get, set]
 Cookie container, for compatibility with proxy classes that are derived from the System.Web.Services.Protocols.HttpWebClientProtocol class. More...
 
- Properties inherited from IG.Lib.IIdentifiable
int Id [get]
 Returns unique ID (in the scope of a given type) of the current object. More...
 
- Properties inherited from IG.Lib.ILockable
object Lock [get]
 

Private Attributes

readonly object _lock = new object()
 

Detailed Description

Base class for IGLib webservices.

Member Function Documentation

static int IG.Web.WSBaseClass.GetNextId ( )
inlinestaticprotected

Returns a new ID for a web service object.

References IG.Lib.Util.LockGlobal.

virtual string IG.Web.WSBaseClass.GetServiceName ( )
inlinevirtual

Returns name of the web service.

Usually, address (URL) of the web service will consists of some base address and service name.

Implements IG.Web.IWSBase.

virtual void IG.Web.WSBaseClass.SetServiceName ( string  name)
inlinevirtual

Sets name of the web service.

Usually, address (URL) of the web service will consists of some base address and service name.

Implements IG.Web.IWSBase.

void IG.Web.WSBaseClass.SetOutputLevel ( int  level)
inline

Sets the level of output generated by the service.

Parameters
levelLevel of output generated by the service. 0 or less means that all output should be suppressed, higher numbers mean more output.
int IG.Web.WSBaseClass.GetOutputLevel ( )
inline

Returns the current level of output generated by the service.

Parameters
levelLevel of output generated by the service. 0 or less means that all output should be suppressed, higher numbers mean more output.
string IG.Web.WSBaseClass.TestService ( )
inline

Tests whether the web service is alive.

Returns a string identifying web service' class and object ID.

To test, right-click the Web Service's .asmx file and select View in a browser.

Returns

Implements IG.Web.IWSBase.

string IG.Web.WSBaseClass.TestServiceCmd ( string  commandlineArguments)
inline

Tests whether the web service is alive.

Returns a string identifying web service' class and object ID.

To test, right-click the Web Service's .asmx file and select View in a browser.

Returns

Implements IG.Web.IWSBase.

References IG.Lib.UtilStr.GetArgumentsArray().

string IG.Web.WSBaseClass.TestServiceArgs ( string[]  commandlineArguments)
inline

Tests whether the web service is alive.

Returns a string identifying web service' class and object ID.

To test, right-click the Web Service's .asmx file and select View in a browser.

Returns

Implements IG.Web.IWSBase.

string IG.Web.WSBaseClass.TestCount ( )
inline

Web service method example. Increments a static counter.

To test, right-click the Web Service's .asmx file and select View in Browser

Returns

Implements IG.Web.IWSBase.

Member Data Documentation

const string IG.Web.WSBaseClass.DefaultNamespace = "http://www2.arnes.si/~ljc3m2/igor/iglib/"
string IG.Web.WSBaseClass._url
protected
CookieContainer IG.Web.WSBaseClass._cookieContainer
protected
string IG.Web.WSBaseClass._namespace = DefaultNamespace
staticprotected
const int IG.Web.WSBaseClass.CacheDurationTimeBase = 10
protected
int IG.Web.WSBaseClass._nextId = 0
staticprotected
int IG.Web.WSBaseClass._id = GetNextId()
protected
readonly object IG.Web.WSBaseClass._lock = new object()
private
string IG.Web.WSBaseClass._name
staticprotected
string IG.Web.WSBaseClass.VarNameOutputLevel = "OutputLevel"
static
const string IG.Web.WSBaseClass.VarNumTestCalls = "NumTestCalls__IGLib_Service_Base"
protected
int IG.Web.WSBaseClass._testCount
staticprotected

Property Documentation

virtual string IG.Web.WSBaseClass.Url
getset

URL of the web service.

This is put into Web service such that base service classes can be used instead of proxy classes, which may be useful when the appropriate service references are not available to generate the proxy classes.

virtual CookieContainer IG.Web.WSBaseClass.CookieContainer
getset

Cookie container, for compatibility with proxy classes that are derived from the System.Web.Services.Protocols.HttpWebClientProtocol class.

string IG.Web.WSBaseClass.NameSpace
staticgetset
int IG.Web.WSBaseClass.NextIdToBeAssigned
staticget

Returns the next service object ID to be assigned.

virtual int IG.Web.WSBaseClass.Id
getprotected set
object IG.Web.WSBaseClass.Lock
get

Object used for locking of the current object.

int IG.Web.WSBaseClass.OutputLevel
getsetprotected

Internal flag indicating the level of output the current object generates (e.g. output to the console).


The documentation for this class was generated from the following file: