{캐시핸들러}3.제공 함수 목록

제공되는 함수

<표1> 제공되는 함수

생성자 및 함수	사용가능 버전	기능
open	all	캐시 열기
close	all	캐시 닫기
save_id	1.0.0	캐시 ID 지정
read	all	캐시 데이터 읽기
write	all	캐시 데이터 쓰기
destroy	all	캐시 데이터 지우기

save_id() 함수는 생성된 하나의 객체를 통해 다중 캐시 데이터를 다루기 위해 1.0.0 버전부터 제공되는 함수입니다.

1.0.0 이전 버전에서 제공되던 gc() 함수는 불필요한 쓰레기를 청소하는 garbage collection을 위해 작성된 함수입니다. 1.0.0 버전부터는 gc() 함수가 open() 함수 내에 포함되어 자동으로 수행됩니다. 따라서 1.0.0 버전부터는 gc() 함수를 사용할 수 없습니다.

bool open();

이 함수는 캐시를 열 때 사용합니다. 현재는 불필요한 캐시 데이터를 청소하는 garbage collection을 주로 수행하고 있습니다.

이 함수가 수행된 이후에 각 캐시 데이터에 대하여 save_id(), read(), write(), destroy() 함수를 이용하여 각각의 캐시 데이터를 다룰 수 있습니다.

이 함수는 성공하면 true를, 에러가 발생하면 false를 반환합니다.

bool close();

이 함수는 캐시를 닫을 때 사용합니다. 한 개 이상의 캐시 데이터를 저장한 후에 수행해야할 마무리 작업을 수행하기 위해 준비된 함수입니다. 따라서 현재 문서에서 각각의 캐시 데이터를 더 이상 다룰 필요가 없는 시점에서 close() 함수를 반드시 실행하여 주시기 바랍니다.

close() 함수가 수행된 후에는 save_id(), read(), write(), destroy() 함수를 실행할 수 없습니다.

이 함수는 성공하면 true를, 에러가 발생하면 false를 반환합니다.

string save_id(string id);

1.0.0 버전부터는 open() 함수를 수행한 이후에도 여러 개의 캐시 ID를 다룰 수 있도록 save_id() 함수를 제공합니다. 이 함수의 인수로 지정되는 id는 파일시스템용 캐시핸들러의 경우에서는 캐시 데이터를 저장되는 파일의 이름으로 사용됩니다.

이 함수는 open() 함수를 실행한 후, close() 함수를 실행하기 전에 사용하여야 합니다.

이 함수를 실행하면 이전에 지정된 캐시 ID가 반환됩니다. 만약 이전에 지정된 캐시 ID가 없었다면 기본값이 "_HW_CACHE_ID"가 반환됩니다.

string read();

캐시 데이터를 읽어들일 때 사용하는 함수입니다. 이 함수를 수행하기 전에 읽어들일 캐시 ID(파일시스템의 경우 파일명)는 생성자 또는 save_id() 함수를 통해 미리 지정하여야 합니다.

만약 지정하지 않게 되면 항상 기본값이 "_HW_CACHE_ID"라는 캐시 ID로 캐시 데이터가 저장됩니다. 따라서 저장되는 캐시 데이터를 다른 것과 구별하기 위해 캐시 ID를 반드시 지정하여 주시기 바랍니다.

이 함수는 open() 함수를 실행한 후, close() 함수를 실행하기 전에 사용하여야 합니다.

이 함수는 성공하면 지정된 캐시 ID에 대한 문자열 형식의 캐시 데이터를 반환하며, 에러가 발생하면 false를 반환합니다.

bool write([string value]);

데이터를 캐시 저장디렉토리에 기록할 때 이 함수를 수행합니다. 이 함수에 전달할 데이터의 형식은 반드시 문자열이어야 합니다. 만약 배열과 같은 값을 캐시하려면 먼저 serialize() 함수 등을 이용하여 문자열로 변환한 후 write() 함수에게 넘겨주어야 합니다.

이 함수는 open() 함수를 실행한 후, close() 함수를 실행하기 전에 사용하여야 합니다.

캐시 데이터의 내용을 변경하지 않고 다만 캐시 파일의 작성 날짜(file modification time)만을 현재시간으로 변경하려면 인수없이 write() 함수를 수행하기 바랍니다.

이 함수는 성공하면 true를, 에러가 발생하면 false를 반환합니다.

bool destroy();

더 이상 필요없는 쓰레기인 캐시 데이터를 강제로 지워주기위해 수행되는 함수입니다.

이 함수는 open() 함수를 실행한 후, close() 함수를 실행하기 전에 사용하여야 합니다.

이 함수는 성공하면 true를, 에러가 발생하면 false를 반환합니다.