IPPOLib
 All Classes Files Functions Variables Typedefs Macros
Public Member Functions | List of all members
GeneralOption Class Reference

#include <generaloption.h>

Public Member Functions

 GeneralOption ()
 GeneralOption::GeneralOption.
 GeneralOption (int socketudp)
 GeneralOption.
 GeneralOption (int socketudp, pthread_mutex_t lock)
 GeneralOption.
 ~GeneralOption ()
int retries ()
 GeneralOption::retries.
void set_retries (int retries)
 GeneralOption::set_retries.
int timeout ()
 GeneralOption::timeout.
void set_timeout (int timeout)
 GeneralOption::set_timeout.
int ttl ()
 GeneralOption::ttl.
void set_ttl (int ttl)
 GeneralOption::set_ttl.
pid_t ip_id ()
 GeneralOption::ip_id.
std::string eth ()
 GeneralOption::eth get the name of eth.
void set_eth (std::string eth)
 GeneralOption::set_eth.
int socketudp ()
 GeneralOption::socketudp.
void set_socketudp (int socketudp)
 GeneralOption::set_socketudp.
pthread_mutex_t lock ()
 GeneralOption::lock.
void set_lock (pthread_mutex_t lock)
 GeneralOption::set_lock.
int protocol_number ()
 GeneralOption::protocol_number.
void set_protocol_number (int protocol_number)
 GeneralOption::set_protocol_number.
bool verbose_mode ()
 GeneralOption::verbose_mode.
void set_verbose_mode (bool verbose_mode)
 GeneralOption::set_verbose_mode.
uint16 src_port ()
 GeneralOption::src_port.
void set_src_port (uint16 src_port)
 GeneralOption::set_src_port.
uint16 dst_port ()
 GeneralOption::dst_port.
void set_dst_port (uint16 dst_port)
 GeneralOption::set_dst_port.

Detailed Description

Definition at line 43 of file generaloption.h.

Constructor & Destructor Documentation

GeneralOption::GeneralOption ( )

GeneralOption::GeneralOption.

null constructor which instantiates params to default values, creates a socketudp and a lock

Definition at line 35 of file generaloption.cpp.

GeneralOption::GeneralOption ( int  socketudp)

GeneralOption.

null constructor which instantiates params to default values, sets the socketudp to input param

Parameters
socketudpidentifier of socket udp

Definition at line 80 of file generaloption.cpp.

Here is the call graph for this function:

GeneralOption::GeneralOption ( int  socketudp,
pthread_mutex_t  lock 
)

GeneralOption.

null constructor which instantiates params to default values, sets the socketudp and lock to input params

Parameters
socketudpidentifier of socket udp
lockidentifier of lock

Definition at line 92 of file generaloption.cpp.

Here is the call graph for this function:

GeneralOption::~GeneralOption ( )

Definition at line 99 of file generaloption.cpp.

Member Function Documentation

uint16 GeneralOption::dst_port ( )

GeneralOption::dst_port.

destination port number user in probing

Returns
uint16 destination port number

Definition at line 329 of file generaloption.cpp.

Here is the caller graph for this function:

std::string GeneralOption::eth ( )

GeneralOption::eth get the name of eth.

Returns
string of eth

Definition at line 209 of file generaloption.cpp.

Here is the caller graph for this function:

pid_t GeneralOption::ip_id ( )

GeneralOption::ip_id.

get the value of ID fiel to set in sender IP header

Returns
pid_t value of ID

Definition at line 199 of file generaloption.cpp.

pthread_mutex_t GeneralOption::lock ( )

GeneralOption::lock.

get the lock

Returns
lock value

Definition at line 249 of file generaloption.cpp.

Here is the caller graph for this function:

int GeneralOption::protocol_number ( )

GeneralOption::protocol_number.

get the protocol number used to send probe

Returns
integer value about protocol number

Definition at line 269 of file generaloption.cpp.

Here is the caller graph for this function:

int GeneralOption::retries ( )

GeneralOption::retries.

PUBLIC METHOD get the number of retries to send probe if no response is obtained

Returns
integer value of retries to obtain response to sender probe

Definition at line 139 of file generaloption.cpp.

Here is the caller graph for this function:

void GeneralOption::set_dst_port ( uint16  dst_port)

GeneralOption::set_dst_port.

set destination port number to use in probing

Parameters
dst_portuint16 value of destination port number

Definition at line 339 of file generaloption.cpp.

Here is the call graph for this function:

void GeneralOption::set_eth ( std::string  eth)

GeneralOption::set_eth.

set the name of eth

Parameters
ethstring value of eth

Definition at line 219 of file generaloption.cpp.

Here is the call graph for this function:

void GeneralOption::set_lock ( pthread_mutex_t  lock)

GeneralOption::set_lock.

set the lock

Parameters
lock

Definition at line 259 of file generaloption.cpp.

Here is the call graph for this function:

void GeneralOption::set_protocol_number ( int  protocol_number)

GeneralOption::set_protocol_number.

set the protocol number to send probe with a specific protocol

Parameters
protocol_numbernumber of protocol used to reach destination IP address

Definition at line 279 of file generaloption.cpp.

Here is the call graph for this function:

void GeneralOption::set_retries ( int  retries)

GeneralOption::set_retries.

set the number of retries to send probe if no response is obtained

Parameters
retriesnumber of retry

Definition at line 149 of file generaloption.cpp.

Here is the call graph for this function:

void GeneralOption::set_socketudp ( int  socketudp)

GeneralOption::set_socketudp.

set socket to use in probing if it is opened outside library

Parameters
socketudpinteger value of socket

Definition at line 239 of file generaloption.cpp.

Here is the call graph for this function:

void GeneralOption::set_src_port ( uint16  src_port)

GeneralOption::set_src_port.

set source port number to use in probing

Parameters
src_portuint16 value of source port number

Definition at line 319 of file generaloption.cpp.

Here is the call graph for this function:

void GeneralOption::set_timeout ( int  timeout)

GeneralOption::set_timeout.

set the time to attend a response to sender probe

Parameters
timeoutvalue of timeout

Definition at line 169 of file generaloption.cpp.

Here is the call graph for this function:

void GeneralOption::set_ttl ( int  ttl)

GeneralOption::set_ttl.

set the value of TTL field in sender IP header

Parameters
ttlvalue of TTL to set in sender IP header

Definition at line 189 of file generaloption.cpp.

Here is the call graph for this function:

void GeneralOption::set_verbose_mode ( bool  verbose_mode)

GeneralOption::set_verbose_mode.

set true if verbose mode is enabled

Parameters
verbose_modeboolean value to set verbose mode. False by default.

Definition at line 299 of file generaloption.cpp.

Here is the call graph for this function:

int GeneralOption::socketudp ( )

GeneralOption::socketudp.

get the identification of socket

Returns
integer value about socket identification

Definition at line 229 of file generaloption.cpp.

Here is the caller graph for this function:

uint16 GeneralOption::src_port ( )

GeneralOption::src_port.

source port number used in probing

Returns
uint16 source port number

Definition at line 309 of file generaloption.cpp.

Here is the caller graph for this function:

int GeneralOption::timeout ( )

GeneralOption::timeout.

get the time in which obtains a response

Returns
integer value of timeout

Definition at line 159 of file generaloption.cpp.

Here is the caller graph for this function:

int GeneralOption::ttl ( )

GeneralOption::ttl.

get the value of TTL field to set in sender IP header

Returns
integer value of TTL

Definition at line 179 of file generaloption.cpp.

Here is the caller graph for this function:

bool GeneralOption::verbose_mode ( )

GeneralOption::verbose_mode.

true if verbose mode is enabled

Returns
boolean value about verbose mode, true if enabled false otherwise

Definition at line 289 of file generaloption.cpp.

Here is the caller graph for this function:


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