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

#include <Channel.hpp>

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

Public 타입
enum	{ UNLIMIT = 0 }
	채널에 입장 가능한 최대 유저 수의 제한이 없음을 나타낸다. 더 자세히 ...

Public 멤버 함수
	Channel ()
	Channel 객체의 기본 생성자.

virtual	~Channel ()
	Channel 객체의 소멸자.

bool	IsUserExist (const std::string &IN nickname) const
	채널에 유저가 존재하는지 확인하는 함수.

bool	IsOperator (const std::string &IN nickname) const
	유저가 채널의 operator인지 확인하는 함수.

bool	IsInvited (const std::string &IN nickname) const
	유저가 채널에 초대되었는지 확인하는 함수.

bool	IsProtectedTopic () const
	채널의 topic을 operator만 설정할 수 있는지 확인하는 함수.

bool	IsInviteOnly () const
	채널이 초대 전용으로 설정되었는지 확인하는 함수.

bool	IsKeyRequired () const
	채널에 key가 설정되었는지 확인하는 함수.

bool	IsLimitedMaxUserCount () const
	채널에 최대 입장 유저 수 제한이 설정되었는지 확인하는 함수.

bool	IsChannelEmpty () const
	채널에 유저가 없는지 확인하는 함수.

const std::string &	GetName () const
	Channel 객체의 name을 반환하는 함수.

const std::string &	GetTopic () const
	Channel 객체의 topic을 반환하는 함수.

uint32	GetMaxUserCount () const
	Channel 객체의 max user count을 반환하는 함수.

const std::string &	GetKey () const
	Channel 객체의 key를 반환하는 함수.

uint32	GetCurrentUserCount () const
	현재 채널에 존재하는 유저의 수를 반환하는 함수.

const std::map< std::string, User > &	GetUsers () const
	현재 채널에 존재하는 유저 목록을 반환하는 함수.

const std::map< std::string, User > &	GetOperators () const
	현재 채널에 존재하는 operator 목록을 반환하는 함수.

std::string	GetAllUsersNickname () const
	현재 채널에 존재하는 유저들의 nickname 목록을 반환하는 함수.

std::string	GetModeString () const
	현재 채널에 설정된 mode를 반환하는 함수.

std::string	GetModeArgument () const
	현재 채널에 설정된 mode에 대한 인자들을 반환하는 함수.

void	SetName (const std::string &IN channelName)
	Channel 객체의 name을 설정하는 함수.

void	SetTopic (const std::string &IN topic)
	Channel 객체의 topic을 설정하는 함수.

void	SetMaxUserCount (uint32 IN maxUserCount)
	Channel 객체의 max user count를 설정하는 함수.

void	SetKey (const std::string &IN key)
	Channel 객체의 key를 설정하는 함수.

void	SetProtectedTopic ()
	채널의 topic을 operator만 설정할 수 있도록 하는 함수.

void	SetInviteOnly ()
	채널을 초대 전용으로 설정하는 함수.

void	SetLimitedMaxUserCount ()
	채널에 입장 가능한 최대 유저 수 제한을 설정하는 함수.

void	SetKeyRequired ()
	채널의 key를 설정하는 함수.

void	UnsetProtectedTopic ()
	채널의 topic을 모두가 설정할 수 있도록 하는 함수.

void	UnsetInviteOnly ()
	초대 전용 설정을 해제하는 함수.

void	UnsetLimitedMaxUserCount ()
	채널에 입장 가능한 최대 유저 수 제한을 해제하는 함수.

void	UnsetKeyRequired ()
	채널의 key를 해제하는 함수.

void	AddUser (const std::string &IN nickname, const User &IN user)
	채널에 유저를 추가하는 함수.

void	AddOperator (const std::string &IN nickname, const User &IN user)
	채널에 operator를 추가하는 함수.

void	AddInvitedUser (const std::string &IN nickname, const User &IN user)
	채널에 초대 받은 유저를 추가하는 함수.

void	DeleteTopic ()
	채널의 topic을 삭제하는 함수.

void	DeleteUser (const std::string &IN nickname)
	채널의 유저를 삭제하는 함수.

void	DeleteOperator (const std::string &IN nickname)
	채널의 operator를 삭제하는 함수.

void	DeleteInvitedUser (const std::string &IN nickname)
	채널에 초대 받은 유저를 삭제하는 함수.

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

const Channel &	operator= (const Channel &IN channel)
	Channel 객체의 복사 대입 연산자.

Private 속성
std::string	mName
	Channel 객체의 이름을 저장하는 멤버 변수.

std::string	mTopic
	Channel 객체의 topic을 저장하는 멤버 변수.

uint32	mMaxUserCount
	Channel 객체의 max user count을 저장하는 멤버 변수.

std::string	mKey
	Channel 객체의 key를 저장하는 멤버 변수.

std::map< std::string, User >	mUsers
	채널에 입장한 유저의 목록을 저장하는 멤버 변수.

std::map< std::string, User >	mOperators
	채널에 입장한 operator의 목록을 저장하는 멤버 변수.

std::map< std::string, User >	mInvitedUsers
	채널에 초대된 유저의 목록을 저장하는 멤버 변수.

bool	mbIsProtectedTopic
	채널의 topic 설정에 operator 권한이 필요한 상태인지를 저장하는 멤버 변수.

bool	mbIsInviteOnly
	채널이 초대 전용 상태인지 저장하는 멤버 변수.

bool	mbIsLimitedMaxUserCount
	채널에 입장 가능한 최대 유저 수 제한이 설정된 상태인지를 저장하는 멤버 변수.

bool	mbIsKeyRequired
	채널에 key가 설정된 상태인지 저장하는 멤버 변수.

상세한 설명

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

멤버 열거형 문서화

◆ anonymous enum

anonymous enum

채널에 입장 가능한 최대 유저 수의 제한이 없음을 나타낸다.

열거형 멤버
UNLIMIT

생성자 & 소멸자 문서화

◆ Channel() [1/2]

grc::Channel::Channel ( )

Channel 객체의 기본 생성자.

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

◆ ~Channel()

grc::Channel::~Channel ( )

virtual

Channel 객체의 소멸자.

◆ Channel() [2/2]

grc::Channel::Channel ( const Channel &IN channel )

private

Channel 객체의 복사 생성자.

(사용되지 않음)

매개변수

channel 복사할 Channel 객체.

멤버 함수 문서화

◆ IsUserExist()

bool grc::Channel::IsUserExist ( const std::string &IN nickname ) const

채널에 유저가 존재하는지 확인하는 함수.

매개변수

nickname target nickname.

반환값: true; false

◆ IsOperator()

bool grc::Channel::IsOperator ( const std::string &IN nickname ) const

유저가 채널의 operator인지 확인하는 함수.

매개변수

nickname target nickname.

반환값: true; false

◆ IsInvited()

bool grc::Channel::IsInvited ( const std::string &IN nickname ) const

유저가 채널에 초대되었는지 확인하는 함수.

매개변수

nickname target nickname.

반환값: true; false

◆ IsProtectedTopic()

bool grc::Channel::IsProtectedTopic ( ) const

채널의 topic을 operator만 설정할 수 있는지 확인하는 함수.

반환값: true; false

◆ IsInviteOnly()

bool grc::Channel::IsInviteOnly ( ) const

채널이 초대 전용으로 설정되었는지 확인하는 함수.

반환값: true; false

◆ IsKeyRequired()

bool grc::Channel::IsKeyRequired ( ) const

채널에 key가 설정되었는지 확인하는 함수.

반환값: true; false

◆ IsLimitedMaxUserCount()

bool grc::Channel::IsLimitedMaxUserCount ( ) const

채널에 최대 입장 유저 수 제한이 설정되었는지 확인하는 함수.

반환값: true; false

◆ IsChannelEmpty()

bool grc::Channel::IsChannelEmpty ( ) const

채널에 유저가 없는지 확인하는 함수.

반환값: true; false

◆ GetName()

const std::string & grc::Channel::GetName ( ) const

Channel 객체의 name을 반환하는 함수.

반환값: const std::string& : Channel 객체의 name.

◆ GetTopic()

const std::string & grc::Channel::GetTopic ( ) const

Channel 객체의 topic을 반환하는 함수.

반환값: const std::string& : Channel 객체의 topic.

◆ GetMaxUserCount()

uint32 grc::Channel::GetMaxUserCount ( ) const

Channel 객체의 max user count을 반환하는 함수.

반환값: uint32 : Channel 객체의 max user count.

◆ GetKey()

const std::string & grc::Channel::GetKey ( ) const

Channel 객체의 key를 반환하는 함수.

반환값: const std::string& : Channel 객체의 key.

◆ GetCurrentUserCount()

uint32 grc::Channel::GetCurrentUserCount ( ) const

현재 채널에 존재하는 유저의 수를 반환하는 함수.

반환값: uint32 : Channel 객체에 존재하는 유저의 수.

◆ GetUsers()

const std::map< std::string, User > & grc::Channel::GetUsers ( ) const

현재 채널에 존재하는 유저 목록을 반환하는 함수.

반환값: const std::map<std::string, User>& : 멤버 변수 mUsers 반환.

◆ GetOperators()

const std::map< std::string, User > & grc::Channel::GetOperators ( ) const

현재 채널에 존재하는 operator 목록을 반환하는 함수.

반환값: const std::map<std::string, User>& : 멤버 변수 mOperators 반환.

◆ GetAllUsersNickname()

std::string grc::Channel::GetAllUsersNickname ( ) const

현재 채널에 존재하는 유저들의 nickname 목록을 반환하는 함수.

반환값: std::string : 공백(' ')으로 분리된 채널에 존재하는 유저 nickname 목록.

◆ GetModeString()

std::string grc::Channel::GetModeString ( ) const

현재 채널에 설정된 mode를 반환하는 함수.

반환값: std::string : 채널에 설정된 mode.

◆ GetModeArgument()

std::string grc::Channel::GetModeArgument ( ) const

현재 채널에 설정된 mode에 대한 인자들을 반환하는 함수.

반환값: std::string : 채널에 설정된 mode에 대한 인자.

◆ SetName()

void grc::Channel::SetName ( const std::string &IN channelName )

Channel 객체의 name을 설정하는 함수.

매개변수

channelName target channelName.

◆ SetTopic()

void grc::Channel::SetTopic ( const std::string &IN topic )

Channel 객체의 topic을 설정하는 함수.

매개변수

topic target topic.

◆ SetMaxUserCount()

void grc::Channel::SetMaxUserCount ( uint32 IN maxUserCount )

Channel 객체의 max user count를 설정하는 함수.

매개변수

maxUserCount target maxUserCount.

◆ SetKey()

void grc::Channel::SetKey ( const std::string &IN key )

Channel 객체의 key를 설정하는 함수.

매개변수

key	target key.

◆ SetProtectedTopic()

void grc::Channel::SetProtectedTopic ( )

채널의 topic을 operator만 설정할 수 있도록 하는 함수.

멤버 변수 mbIsProtectedTopic을 true로 설정한다.

◆ SetInviteOnly()

void grc::Channel::SetInviteOnly ( )

채널을 초대 전용으로 설정하는 함수.

멤버 변수 mbIsInviteOnly를 true로 설정한다.

◆ SetLimitedMaxUserCount()

void grc::Channel::SetLimitedMaxUserCount ( )

채널에 입장 가능한 최대 유저 수 제한을 설정하는 함수.

멤버 변수 mbIsLimitedMaxUserCount를 true로 설정한다.

◆ SetKeyRequired()

void grc::Channel::SetKeyRequired ( )

채널의 key를 설정하는 함수.

멤버 변수 mbIsKeyRequired를 true로 설정한다.

◆ UnsetProtectedTopic()

void grc::Channel::UnsetProtectedTopic ( )

채널의 topic을 모두가 설정할 수 있도록 하는 함수.

멤버 변수 mbIsProtectedTopic을 false로 설정한다.

◆ UnsetInviteOnly()

void grc::Channel::UnsetInviteOnly ( )

초대 전용 설정을 해제하는 함수.

멤버 변수 mbIsInviteOnly를 false로 설정한다.

◆ UnsetLimitedMaxUserCount()

void grc::Channel::UnsetLimitedMaxUserCount ( )

채널에 입장 가능한 최대 유저 수 제한을 해제하는 함수.

멤버 변수 mbIsLimitedMaxUserCount를 false로 설정한다.

◆ UnsetKeyRequired()

void grc::Channel::UnsetKeyRequired ( )

채널의 key를 해제하는 함수.

멤버 변수 mbIsKeyRequired를 false로 설정한다.

◆ AddUser()

void grc::Channel::AddUser	(	const std::string &IN	nickname,
		const User &IN	user )

채널에 유저를 추가하는 함수.

매개변수

nickname	추가할 유저의 nickname.
user	추가할 User 객체.

◆ AddOperator()

void grc::Channel::AddOperator	(	const std::string &IN	nickname,
		const User &IN	user )

채널에 operator를 추가하는 함수.

매개변수

nickname	추가할 operator의 nickname.
user	추가할 User 객체.

◆ AddInvitedUser()

void grc::Channel::AddInvitedUser	(	const std::string &IN	nickname,
		const User &IN	user )

채널에 초대 받은 유저를 추가하는 함수.

매개변수

nickname	초대 받은 유저의 nickname.
user	추가할 User 객체.

◆ DeleteTopic()

void grc::Channel::DeleteTopic ( )

채널의 topic을 삭제하는 함수.

◆ DeleteUser()

void grc::Channel::DeleteUser ( const std::string &IN nickname )

채널의 유저를 삭제하는 함수.

매개변수

nickname 삭제할 유저의 nickname.

◆ DeleteOperator()

void grc::Channel::DeleteOperator ( const std::string &IN nickname )

채널의 operator를 삭제하는 함수.

매개변수

nickname 삭제할 operator의 nickname.

◆ DeleteInvitedUser()

void grc::Channel::DeleteInvitedUser ( const std::string &IN nickname )

채널에 초대 받은 유저를 삭제하는 함수.

매개변수

nickname 삭제할 유저의 nickname.

◆ operator=()

const Channel & grc::Channel::operator= ( const Channel &IN channel )

private

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

(사용되지 않음)

매개변수

channel 복사할 Channel 객체.

반환값: const Channel& : 복사된 Channel 객체.

멤버 데이터 문서화

◆ mName

std::string grc::Channel::mName

private

Channel 객체의 이름을 저장하는 멤버 변수.

◆ mTopic

std::string grc::Channel::mTopic

private

Channel 객체의 topic을 저장하는 멤버 변수.

◆ mMaxUserCount

uint32 grc::Channel::mMaxUserCount

private

Channel 객체의 max user count을 저장하는 멤버 변수.

◆ mKey

std::string grc::Channel::mKey

private

Channel 객체의 key를 저장하는 멤버 변수.

◆ mUsers

std::map<std::string, User> grc::Channel::mUsers

private

채널에 입장한 유저의 목록을 저장하는 멤버 변수.

◆ mOperators

std::map<std::string, User> grc::Channel::mOperators

private

채널에 입장한 operator의 목록을 저장하는 멤버 변수.

◆ mInvitedUsers

std::map<std::string, User> grc::Channel::mInvitedUsers

private

채널에 초대된 유저의 목록을 저장하는 멤버 변수.

◆ mbIsProtectedTopic

bool grc::Channel::mbIsProtectedTopic

private

채널의 topic 설정에 operator 권한이 필요한 상태인지를 저장하는 멤버 변수.

◆ mbIsInviteOnly

bool grc::Channel::mbIsInviteOnly

private

채널이 초대 전용 상태인지 저장하는 멤버 변수.

◆ mbIsLimitedMaxUserCount

bool grc::Channel::mbIsLimitedMaxUserCount

private

채널에 입장 가능한 최대 유저 수 제한이 설정된 상태인지를 저장하는 멤버 변수.

◆ mbIsKeyRequired

bool grc::Channel::mbIsKeyRequired

private

채널에 key가 설정된 상태인지 저장하는 멤버 변수.

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

src/grc/irc/Channel.hpp
src/grc/irc/Channel.cpp

Public 타입

Public 멤버 함수

Private 멤버 함수

Private 속성

상세한 설명

멤버 열거형 문서화

◆ anonymous enum

생성자 & 소멸자 문서화

◆ Channel() [1/2]

◆ ~Channel()

◆ Channel() [2/2]

멤버 함수 문서화

◆ IsUserExist()

◆ IsOperator()

◆ IsInvited()

◆ IsProtectedTopic()

◆ IsInviteOnly()

◆ IsKeyRequired()

◆ IsLimitedMaxUserCount()

◆ IsChannelEmpty()

◆ GetName()

◆ GetTopic()

◆ GetMaxUserCount()

◆ GetKey()

◆ GetCurrentUserCount()

◆ GetUsers()

◆ GetOperators()

◆ GetAllUsersNickname()

◆ GetModeString()

◆ GetModeArgument()

◆ SetName()

◆ SetTopic()

◆ SetMaxUserCount()

◆ SetKey()

◆ SetProtectedTopic()

◆ SetInviteOnly()

◆ SetLimitedMaxUserCount()

◆ SetKeyRequired()

◆ UnsetProtectedTopic()

◆ UnsetInviteOnly()

◆ UnsetLimitedMaxUserCount()

◆ UnsetKeyRequired()

◆ AddUser()

◆ AddOperator()

◆ AddInvitedUser()

◆ DeleteTopic()

◆ DeleteUser()

◆ DeleteOperator()

◆ DeleteInvitedUser()

◆ operator=()

멤버 데이터 문서화

◆ mName

◆ mTopic

◆ mMaxUserCount

◆ mKey

◆ mUsers

◆ mOperators

◆ mInvitedUsers

◆ mbIsProtectedTopic

◆ mbIsInviteOnly

◆ mbIsLimitedMaxUserCount

◆ mbIsKeyRequired