grc::User 클래스 참조

IRC에서 생성되는 User 객체를 정의하는 클래스. 더 자세히 ...

#include <User.hpp>

grc::User에 대한 협력 다이어그램:

Public 멤버 함수
	User ()
	User 객체의 기본 생성자.
const User &	operator= (const User &IN User)
	User 객체의 복사 대입 연산자.
virtual	~User ()
	User 객체의 소멸자.
bool	IsAuthenticated () const
	User가 인증 되었는지 확인하는 함수.
bool	IsRegistered () const
	User가 등록 되었는지 확인하는 함수.
int32	GetSocket () const
	User 객체의 소켓을 반환하는 함수.
const std::string &	GetNickname () const
	User 객체의 nickname을 반환하는 함수.
const std::string &	GetUsername () const
	User 객체의 username을 반환하는 함수.
const std::string &	GetHostname () const
	User 객체의 hostname을 반환하는 함수.
const std::string &	GetServername () const
	User 객체의 servername을 반환하는 함수.
const std::string &	GetRealname () const
	User 객체의 realname을 반환하는 함수.
void	SetSocket (const int32 IN socket)
	User 객체의 소켓을 설정하는 함수.
void	SetAuthenticated ()
	User 객체의 인증 상태를 true로 설정하는 함수.
void	SetRegistered ()
	User 객체의 등록 상태를 true로 설정하는 함수.
void	SetNickname (const std::string &IN nickname)
	User 객체의 nickname을 설정하는 함수.
void	SetUsername (const std::string &IN username)
	User 객체의 username을 설정하는 함수.
void	SetHostname (const std::string &IN hostname)
	User 객체의 hostname을 설정하는 함수.
void	SetServername (const std::string &IN servername)
	User 객체의 servername을 설정하는 함수.
void	SetRealname (const std::string &IN realname)
	User 객체의 realname을 설정하는 함수.

Private 멤버 함수
	User (const User &IN User)
	User 객체의 복사 생성자.

Private 속성
int32	mSocket
	User의 소켓을 저장하는 멤버 변수.
bool	mbIsAuthenticated
	User의 인증 상태를 저장하는 멤버 변수.
bool	mbIsRegistered
	User의 등록 상태를 저장하는 멤버 변수.
std::string	mNickname
	User의 nickname을 저장하는 멤버 변수.
std::string	mUsername
	User의 username을 저장하는 멤버 변수.
std::string	mHostname
	User의 hostname을 저장하는 멤버 변수.
std::string	mServername
	User의 servername을 저장하는 멤버 변수.
std::string	mRealname
	User의 real을 저장하는 멤버 변수.

상세한 설명

IRC에서 생성되는 User 객체를 정의하는 클래스.

생성자 & 소멸자 문서화

User() [1/2]

grc::User::User

(

)

User 객체의 기본 생성자.

객체가 생성될 때, 모든 멤버 변수들을 초기화한다.

~User()

grc::User::~User ( )

virtual

User 객체의 소멸자.

User() [2/2]

grc::User::User ( const User &IN User )

private

User 객체의 복사 생성자.

(사용되지 않음)

매개변수

User	: 복사할 User 객체.

멤버 함수 문서화

operator=()

const User & grc::User::operator=

(

const User &IN

User

)

User 객체의 복사 대입 연산자.

현재 객체에 매개 변수로 받은 User의 값을 전부 복사한다.

매개변수

User	복사할 User 객체.

반환값

const User& : 복사된 User 객체.

IsAuthenticated()

bool grc::User::IsAuthenticated

(

)

const

User가 인증 되었는지 확인하는 함수.

반환값

true

false

IsRegistered()

bool grc::User::IsRegistered

(

)

const

User가 등록 되었는지 확인하는 함수.

반환값

true

false

GetSocket()

int32 grc::User::GetSocket

(

)

const

User 객체의 소켓을 반환하는 함수.

반환값

int32 : User 객체의 소켓.

GetNickname()

const std::string & grc::User::GetNickname

(

)

const

User 객체의 nickname을 반환하는 함수.

반환값

const std::string& : User 객체의 nickname.

GetUsername()

const std::string & grc::User::GetUsername

(

)

const

User 객체의 username을 반환하는 함수.

반환값

const std::string& : User 객체의 username.

GetHostname()

const std::string & grc::User::GetHostname

(

)

const

User 객체의 hostname을 반환하는 함수.

반환값

const std::string& : User 객체의 hostname.

GetServername()

const std::string & grc::User::GetServername

(

)

const

User 객체의 servername을 반환하는 함수.

반환값

const std::string& : User 객체의 servername.

GetRealname()

const std::string & grc::User::GetRealname

(

)

const

User 객체의 realname을 반환하는 함수.

반환값

const std::string& : User 객체의 realname.

SetSocket()

void grc::User::SetSocket

(

const int32 IN

socket

)

User 객체의 소켓을 설정하는 함수.

매개변수

socket

target socket.

SetAuthenticated()

void grc::User::SetAuthenticated

(

)

User 객체의 인증 상태를 true로 설정하는 함수.

SetRegistered()

void grc::User::SetRegistered

(

)

User 객체의 등록 상태를 true로 설정하는 함수.

SetNickname()

void grc::User::SetNickname

(

const std::string &IN

nickname

)

User 객체의 nickname을 설정하는 함수.

매개변수

nickname

target nickname.

SetUsername()

void grc::User::SetUsername

(

const std::string &IN

username

)

User 객체의 username을 설정하는 함수.

매개변수

username

target username.

SetHostname()

void grc::User::SetHostname

(

const std::string &IN

hostname

)

User 객체의 hostname을 설정하는 함수.

매개변수

hostname

target hostname.

SetServername()

void grc::User::SetServername

(

const std::string &IN

servername

)

User 객체의 servername을 설정하는 함수.

매개변수

servername

target servername.

SetRealname()

void grc::User::SetRealname

(

const std::string &IN

realname

)

User 객체의 realname을 설정하는 함수.

매개변수

realname

target realname.

멤버 데이터 문서화

mSocket

int32 grc::User::mSocket

private

User의 소켓을 저장하는 멤버 변수.

mbIsAuthenticated

bool grc::User::mbIsAuthenticated

private

User의 인증 상태를 저장하는 멤버 변수.

mbIsRegistered

bool grc::User::mbIsRegistered

private

User의 등록 상태를 저장하는 멤버 변수.

mNickname

std::string grc::User::mNickname

private

User의 nickname을 저장하는 멤버 변수.

mUsername

std::string grc::User::mUsername

private

User의 username을 저장하는 멤버 변수.

mHostname

std::string grc::User::mHostname

private

User의 hostname을 저장하는 멤버 변수.

mServername

std::string grc::User::mServername

private

User의 servername을 저장하는 멤버 변수.

mRealname

std::string grc::User::mRealname

private

User의 real을 저장하는 멤버 변수.

---

이 클래스에 대한 문서화 페이지는 다음의 파일들로부터 생성되었습니다.:

• src/grc/irc/User.hpp
• src/grc/irc/User.cpp