DCPlusPlus.Hub.SearchParameters

DCPlusPlus.Hub.SearchParameters Class Reference

the parameters needed for a search More...

List of all members.

Public Member Functions

 SearchParameters (string search_string, bool size_restricted, bool is_max_size, int size, SearchFileType file_type, string tth, string username)
 SearchParameters Constructor.
 SearchParameters (ConnectionMode mode, string search_string, bool size_restricted, bool is_max_size, int size, SearchFileType file_type, string tth, string ip, int port)
 SearchParameters Constructor.
 SearchParameters ()
 SearchParameters Constructor.

Public Attributes

SearchFileType file_type
 the specific filetype to search for ,default will be ANY
string ip
 the ip to return the search results to
bool is_max_size
 TRUE if the search is restricted to a max size.
ConnectionMode mode
 the connection mode of the search
int port
 the port to return the search results to
string search_string
 the term to search for
long size
 the size of the size restriction,only used if size_restricted is set to TRUE
bool size_restricted
 TRUE if the search is restricted to a specific size range.
string tth = ""
 the tth to search for
string username
 the search user

Properties

bool HasTTH [get]
 TRUE if the search is for a tth.

Detailed Description

the parameters needed for a search

Definition at line 185 of file Hub.cs.

Constructor & Destructor Documentation

DCPlusPlus.Hub.SearchParameters.SearchParameters (  ) 

SearchParameters Constructor.

Definition at line 240 of file Hub.cs.

00241             {
00242             }

DCPlusPlus.Hub.SearchParameters.SearchParameters ( ConnectionMode  mode,
string  search_string,
bool  size_restricted,
bool  is_max_size,
int  size,
SearchFileType  file_type,
string  tth,
string  ip,
int  port 
)

SearchParameters Constructor.

Parameters:
mode the connection mode of the search
search_string the term to search for
size_restricted TRUE if the search is restricted to a specific size range
is_max_size TRUE if the search is restricted to a max size
size the size of the size restriction,only used if size_restricted is set to TRUE
file_type the specific filetype to search for ,default will be ANY
tth the tth to search for
ip 
port 

Definition at line 255 of file Hub.cs.

00256             {
00257                 this.mode = ConnectionMode.Active;
00258                 this.search_string = search_string;
00259                 this.size_restricted = size_restricted;
00260                 this.is_max_size = is_max_size;
00261                 this.size = size;
00262                 this.file_type = file_type;
00263                 this.ip = ip;
00264                 this.port = port;
00265                 this.username = "";
00266                 this.tth = tth;
00267             }

DCPlusPlus.Hub.SearchParameters.SearchParameters ( string  search_string,
bool  size_restricted,
bool  is_max_size,
int  size,
SearchFileType  file_type,
string  tth,
string  username 
)

SearchParameters Constructor.

Parameters:
search_string the term to search for
size_restricted TRUE if the search is restricted to a specific size range
is_max_size TRUE if the search is resricted to a max size
size the size of the size restriction,only used if size_restricted is set to TRUE
file_type the specific filetype to search for ,default will be ANY
tth the tth to search for
username the search user

Definition at line 278 of file Hub.cs.

00279             {
00280                 this.mode = ConnectionMode.Passive;
00281                 this.search_string = search_string;
00282                 this.size_restricted = size_restricted;
00283                 this.is_max_size = is_max_size;
00284                 this.size = size;
00285                 this.file_type = file_type;
00286                 this.ip = "";
00287                 this.port = 0;
00288                 this.tth = tth;
00289                 this.username = username;
00290             }

Member Data Documentation

SearchFileType DCPlusPlus.Hub.SearchParameters.file_type

the specific filetype to search for ,default will be ANY

Definition at line 210 of file Hub.cs.

Referenced by DCPlusPlus.Hub.InterpretCommand(), and DCPlusPlus.Hub.Search().

string DCPlusPlus.Hub.SearchParameters.ip

the ip to return the search results to

Definition at line 214 of file Hub.cs.

Referenced by DCPlusPlus.Hub.InterpretCommand().

bool DCPlusPlus.Hub.SearchParameters.is_max_size

TRUE if the search is restricted to a max size.

Definition at line 202 of file Hub.cs.

Referenced by DCPlusPlus.Hub.InterpretCommand(), and DCPlusPlus.Hub.Search().

ConnectionMode DCPlusPlus.Hub.SearchParameters.mode

the connection mode of the search

Definition at line 190 of file Hub.cs.

Referenced by DCPlusPlus.Hub.InterpretCommand(), and DCPlusPlus.Hub.SearchReply().

int DCPlusPlus.Hub.SearchParameters.port

the port to return the search results to

Definition at line 218 of file Hub.cs.

Referenced by DCPlusPlus.Hub.InterpretCommand().

string DCPlusPlus.Hub.SearchParameters.search_string

the term to search for

Definition at line 194 of file Hub.cs.

Referenced by DCPlusPlus.Hub.InterpretCommand(), and DCPlusPlus.Hub.Search().

long DCPlusPlus.Hub.SearchParameters.size

the size of the size restriction,only used if size_restricted is set to TRUE

Definition at line 206 of file Hub.cs.

Referenced by DCPlusPlus.Hub.InterpretCommand(), and DCPlusPlus.Hub.Search().

bool DCPlusPlus.Hub.SearchParameters.size_restricted

TRUE if the search is restricted to a specific size range.

Definition at line 198 of file Hub.cs.

Referenced by DCPlusPlus.Hub.InterpretCommand(), and DCPlusPlus.Hub.Search().

string DCPlusPlus.Hub.SearchParameters.tth = ""

the tth to search for

Definition at line 236 of file Hub.cs.

Referenced by DCPlusPlus.Hub.InterpretCommand(), and DCPlusPlus.Hub.SearchReply().

string DCPlusPlus.Hub.SearchParameters.username

the search user

Definition at line 222 of file Hub.cs.

Referenced by DCPlusPlus.Hub.InterpretCommand(), and DCPlusPlus.Hub.SearchReply().

Property Documentation

bool DCPlusPlus.Hub.SearchParameters.HasTTH [get]

TRUE if the search is for a tth.

Definition at line 227 of file Hub.cs.

Referenced by DCPlusPlus.Hub.SearchReply().

The documentation for this class was generated from the following file:
Generated on Wed Mar 7 19:09:30 2007 for DCPlusPlus by  doxygen 1.5.1-p1