grc::ChannelManager 클래스 참조

Channel 객체들을 관리하는 정적 클래스. 더 자세히 ...

#include <ChannelManager.hpp>

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

정적 Public 멤버 함수
static bool	IsChannelExist (const std::string &IN channelName)
	Channel 객체가 존재하는지 확인하는 함수.
static Channel &	GetChannel (const std::string IN channelName)
	특정 Channel 객체를 반환하는 함수.
static std::map< std::string, Channel > &	GetChannels ()
	현재 모든 Channel 객체의 목록을 반환하는 함수.
static void	AddChannel (const std::string &IN channelName)
	Channel 객체를 추가하는 함수.
static void	DeleteChannel (const std::string &IN channelName)
	Channel 객체를 삭제하는 함수.
static void	DeleteUserFromChannel (const User &IN user, const std::string &channelName)
	특정 채널에 존재하는 유저를 삭제하는 함수.
static void	DeleteUserFromAllChannels (const User &IN user)
	모든 채널에서 유저를 삭제하는 함수.
static void	CheckIsEmptyChannelAndDelete (const Channel &IN channel)
	채널이 비었는지 확인 후, 채널을 삭제하는 함수.

Private 멤버 함수
	ChannelManager ()
	ChannelManager 객체의 기본 생성자.

정적 Private 속성
static std::map< std::string, Channel >	sStaticChannels
	현재 IRC에 생성된 모든 Channel 객체의 목록.

상세한 설명

Channel 객체들을 관리하는 정적 클래스.

생성자 & 소멸자 문서화

ChannelManager()

grc::ChannelManager::ChannelManager ( )

private

ChannelManager 객체의 기본 생성자.

(사용되지 않음)

멤버 함수 문서화

IsChannelExist()

bool grc::ChannelManager::IsChannelExist ( const std::string &IN channelName )

static

Channel 객체가 존재하는지 확인하는 함수.

매개변수

channelName

찾을 Channel 객체의 이름.

반환값

true

false

GetChannel()

Channel & grc::ChannelManager::GetChannel ( const std::string IN channelName )

static

특정 Channel 객체를 반환하는 함수.

없는 채널에 대해서 함수를 호출하는 경우, Assertion 발생.

매개변수

channelName

찾을 Channel 객체의 이름.

반환값

Channel& : Channel의 객체를 반환.

GetChannels()

std::map< std::string, Channel > & grc::ChannelManager::GetChannels ( )

static

현재 모든 Channel 객체의 목록을 반환하는 함수.

반환값

std::map<std::string, Channel>& : 멤버 변수 sStaticChannels 반환.

AddChannel()

void grc::ChannelManager::AddChannel ( const std::string &IN channelName )

static

Channel 객체를 추가하는 함수.

매개변수

channelName

추가할 Channel 객체의 이름.

DeleteChannel()

void grc::ChannelManager::DeleteChannel ( const std::string &IN channelName )

static

Channel 객체를 삭제하는 함수.

매개변수

channelName

삭제할 Channel 객체의 이름.

DeleteUserFromChannel()

void grc::ChannelManager::DeleteUserFromChannel ( const User &IN user, const std::string & channelName )

static

특정 채널에 존재하는 유저를 삭제하는 함수.

매개변수

user	삭제할 User 객체.
channelName	유저가 삭제될 Channel 객체의 이름.

DeleteUserFromAllChannels()

void grc::ChannelManager::DeleteUserFromAllChannels ( const User &IN user )

static

모든 채널에서 유저를 삭제하는 함수.

매개변수

user	삭제할 User 객체.

CheckIsEmptyChannelAndDelete()

void grc::ChannelManager::CheckIsEmptyChannelAndDelete ( const Channel &IN channel )

static

채널이 비었는지 확인 후, 채널을 삭제하는 함수.

채널이 비어있지 않은 경우 삭제하지 않는다.

매개변수

channel

검사할 Channel 객체의 이름.

멤버 데이터 문서화

sStaticChannels

std::map< std::string, Channel > grc::ChannelManager::sStaticChannels

staticprivate

현재 IRC에 생성된 모든 Channel 객체의 목록.

---

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

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