OPC UA C++ API

OPC UA의 C++ 공개 API 목록입니다.

모든 종류클래스생성자열거형열거자이벤트필드함수메서드네임스페이스구조체형식 별칭API 145개

• opcua 네임스페이스 — OPC UA C++ API입니다. C ABI의 RAII 래퍼와 QtCore 및 MFC 클라이언트 워커(worker)를 제공합니다.
• MfcClientConfiguration 구조체 — MfcClientWorker의 연결 설정과 ID(identity) 설정입니다.
• MfcClientConfiguration::anonymous 필드 — userName과 userSecret 대신 익명으로 활성화합니다.
• MfcClientConfiguration::applicationUri 필드 — UTF-8로 된 ApplicationUri이며, 최대 4096바이트입니다. 클라이언트 인증서와 일치해야 합니다.
• MfcClientConfiguration::certificateDer 필드 — 클라이언트 애플리케이션 인스턴스 인증서입니다(DER, 최대 64 KiB).
• MfcClientConfiguration::endpoint 필드 — UTF-8로 된 opc.tcp:// 엔드포인트(endpoint) URL이며, 최대 4096바이트입니다.
• MfcClientConfiguration::flags 필드 — ::pdcomm_opcua_option_flags 값의 비트 OR입니다.
• MfcClientConfiguration::mode 필드 — 요청할 ::pdcomm_opcua_security_mode 값입니다.
• MfcClientConfiguration::policy 필드 — 요청할 ::pdcomm_opcua_policy 값입니다.
• MfcClientConfiguration::privateKeyPem 필드 — 그 인증서의 개인 키입니다(PEM, 최대 64 KiB).
• MfcClientConfiguration::timeoutMs 필드 — 각 네트워크 교환과 처리 중인 각 요청의 타임아웃(timeout)이며, 1부터 300000 ms까지입니다.
• MfcClientConfiguration::trustedServerDer 필드 — 신뢰할 서버 인증서입니다(DER, 최대 64 KiB).
• MfcClientConfiguration::userName 필드 — UserNameIdentityToken에 쓰는 UTF-8 사용자 이름이며, 최대 4096바이트입니다. anonymous가 false일 때 사용합니다.
• MfcClientConfiguration::userSecret 필드 — UTF-8 암호이며, 최대 16 KiB입니다. anonymous가 false일 때 사용합니다.
• MfcClientEvent 구조체 — MfcClientWorker::Drain()으로 워커의 메일박스에서 꺼낸 이벤트 하나입니다.
• MfcClientEvent::aborted 필드 — Stopped: 워커가 그 밖의 방식으로 종료되었습니다. 항상 !orderly입니다.
• MfcClientEvent::accepted 필드 — Stopped: Submit()이 받아들인 요청 수입니다.
• MfcClientEvent::completed 필드 — Stopped: 응답으로 끝났거나 begin 또는 response 실패로 끝난 요청 수입니다.
• MfcClientEvent::correlation 필드 — Pending, Completed, Failed: MfcClientWorker::Submit()에 전달한 상관 ID(correlation)입니다. 워커 실패이면 0입니다.
• MfcClientEvent::discarded 필드 — Stopped: abort 실패로 끝난 요청 수입니다.
• MfcClientEvent::kind 필드 — 이벤트 종류입니다.
• MfcClientEvent::metadata 필드 — Completed: 응답의 요청 ID, 인코딩 ID, serviceResult입니다.
• MfcClientEvent::orderly 필드 — Stopped: drain이 CloseSession과 채널 닫기로 끝났습니다.
• MfcClientEvent::ownerThread 필드 — Ready: 네이티브 클라이언트를 소유한 워커 스레드의 Win32 스레드 ID입니다.
• MfcClientEvent::phase 필드 — Failed: begin, response, abort, worker 중 하나입니다.
• MfcClientEvent::reason 필드 — Stopped: drained-and-closed, aborted, native-error, adapter-error 중 하나입니다.
• MfcClientEvent::requestId 필드 — Pending, Completed: 네이티브 요청 ID(requestHandle)입니다.
• MfcClientEvent::status 필드 — Failed: 실패의 ::pdcomm_opcua_status 값입니다.
• MfcClientEvent::text 필드 — Failed: 영문 상세 텍스트이며, 네이티브 호출 직후 워커 스레드에서 복사합니다.
• MfcClientEvent::value 필드 — Completed: 소유된 응답이며, ServiceFault일 수 있습니다. 클라이언트와 워커보다 오래 유지되며, 마지막 참조가 사라질 때까지 네이티브 핸들을 보유합니다.
• MfcClientEventKind 열거형 — MfcClientEvent의 종류입니다. 어떤 멤버가 설정되는지를 결정합니다.
• MfcClientEventKind::Completed 열거자 — 검증된 응답이 도착했습니다. correlation, requestId, metadata, value가 설정됩니다.
• MfcClientEventKind::Failed 열거자 — 요청 또는 워커가 실패했습니다. correlation(워커이면 0), status, phase, text가 설정됩니다.
• MfcClientEventKind::Pending 열거자 — 요청을 보냈습니다. correlation과 requestId가 설정됩니다.
• MfcClientEventKind::Ready 열거자 — 세션이 활성화되었습니다. ownerThread가 설정됩니다.
• MfcClientEventKind::Stopped 열거자 — 워커가 종료되었습니다. 항상 마지막 이벤트입니다. orderly, aborted, 카운터, reason이 설정됩니다.
• MfcClientStop 열거형 — MfcClientWorker::RequestStop()이 워커를 끝내는 방식입니다.
• MfcClientStop::Abort 열거자 — 다음 확인 지점에서 멈추고, 대기 중인 작업을 버리며, 프로토콜 종료 절차 없이 클라이언트를 해제합니다.
• MfcClientStop::Drain 열거자 — 받아들인 모든 요청을 완료한 뒤 세션과 채널을 닫습니다.
• MfcClientWorker 클래스 — 네이티브 OPC UA 클라이언트를 소유하는 일회용(one-shot) MFC 워커 스레드입니다.
• MfcClientWorker::Drain 메서드 — 큐에 있는 모든 이벤트를 순서대로 꺼냅니다. 수신 스레드에서 호출합니다.
• MfcClientWorker::MaximumCommands 필드 — 큐에 있거나 전송 중인, 받아들인 요청의 최대 개수입니다.
• MfcClientWorker::MaximumEvents 필드 — 메일박스에서 동시에 대기할 수 있는 이벤트 수의 상한입니다.
• MfcClientWorker::MaximumQueuedBytes 필드 — 요청 하나의 최대 크기이자, 큐에 있고 아직 보내지 않은 모든 요청을 합친 최대 크기입니다(4 MiB).
• MfcClientWorker::MfcClientWorker 생성자 — 워커를 만듭니다. 연결은 Start()가 시작합니다.
• MfcClientWorker::MfcClientWorker 생성자 — 복사할 수 없습니다.
• MfcClientWorker::RequestStop 메서드 — 워커에 중지를 요청합니다. 스레드 안전합니다.
• MfcClientWorker::Start 메서드 — 워커 스레드를 시작합니다. 한 번만 시작할 수 있습니다.
• MfcClientWorker::Submit 메서드 — UA Binary 서비스 요청 하나를 큐에 넣습니다. 스레드 안전(thread-safe)합니다.
• MfcClientWorker::Wait 메서드 — 워커 스레드가 종료될 때까지 기다립니다. 소유자 스레드에서만 호출합니다.
• MfcClientWorker::operator= 메서드 — 복사 대입할 수 없습니다.
• MfcClientWorker::~MfcClientWorker 메서드 — 중단(abort)을 요청하고, 스레드를 기다린 뒤 자격 증명을 지웁니다.
• buffer 클래스 — 라이브러리가 반환하는, 소유되는 불변 바이트 버퍼입니다.
• buffer::buffer 생성자 — 버퍼 핸들의 소유권을 가져옵니다.
• buffer::copy 메서드 — 버퍼 내용을 복사합니다.
• bytes 함수 — 문자열의 바이트를 ::pdcomm_opcua_bytes 뷰로 빌립니다.
• bytes 함수 — 벡터의 바이트를 ::pdcomm_opcua_bytes 뷰로 빌립니다.
• check 함수 — 실패한 C ABI 상태에 대해 예외를 던집니다.
• client 클래스 — 보안 채널(secure channel) 하나를 사용하는 OPC UA 클라이언트 세션(session)입니다.
• client::activate_anonymous 메서드 — 세션을 익명으로 활성화합니다(ActivateSession).
• client::activate_user_name 메서드 — 사용자 이름과 암호로 세션을 활성화합니다(ActivateSession).
• client::begin 메서드 — UA Binary 서비스 요청 하나를 큐에 넣습니다.
• client::close 메서드 — 세션과 보안 채널을 순서에 맞게 닫습니다.
• client::connect 메서드 — 서버에 연결하고 세션을 만듭니다.
• client::discover 메서드 — 인증 없이 서버의 엔드포인트를 읽습니다.
• client::poll 메서드 — 블로킹 없이 큐에 있는 바이트를 보내고 도착한 응답을 받습니다.
• client::take 메서드 — 요청의 응답이 도착했으면 가져옵니다.
• error 클래스 — C ABI 호출이 실패할 때마다 래퍼가 던지는 예외입니다.
• error::error 생성자 — 예외를 만듭니다.
• error::license_required 메서드 — PDComm 라이선스가 없어 호출이 거부되었는지 알려 줍니다.
• error::status 메서드 — 실패한 호출의 상태를 반환합니다.
• license 클래스 — OPC UA 라이브러리의 PDComm 라이선스입니다. 라이선스 텍스트를 설치하고, 라이선스 상태와 이 호스트의 ID를 읽습니다.
• license::host_id 메서드 — 이 호스트의 ID PDH1-XXXX-XXXX-XXXX-XXXX를 반환합니다.
• license::install 메서드 — 라이선스 텍스트를 설치하고, 이전에 설치한 텍스트를 교체합니다.
• license::status 메서드 — 라이선스 상태 JSON을 반환합니다(pdcomm_opcua_license_status() 참고).
• options 함수 — 라이브러리 기본값으로 채운 클라이언트 옵션을 반환합니다.
• owned 클래스 — ::pdcomm_opcua_handle 하나를 소유하는 이동 전용(move-only) 소유자이며, 모든 래퍼의 기반 클래스입니다.
• owned::operator= 메서드 — 복사 대입을 할 수 없습니다. 핸들의 소유자는 정확히 하나입니다.
• owned::operator= 메서드 — 현재 핸들을 해제한 뒤 other에서 소유권을 가져옵니다.
• owned::owned 생성자 — 빈 소유자를 만듭니다.
• owned::owned 생성자 — 복사할 수 없습니다. 핸들의 소유자는 정확히 하나입니다.
• owned::owned 생성자 — 소유권을 이동합니다. other는 비게 됩니다.
• owned::reset 메서드 — 소유한 핸들을 즉시 해제하고 객체를 비웁니다.
• owned::~owned 메서드 — 소유한 핸들이 있으면 해제합니다.
• qt_client_configuration 구조체 — qt_client_worker의 연결 및 ID 설정입니다.
• qt_client_configuration::anonymous 필드 — user_name과 user_secret 대신 익명으로 활성화합니다.
• qt_client_configuration::application_uri 필드 — ApplicationUri입니다. 최대 4096바이트이며 클라이언트 인증서와 일치해야 합니다.
• qt_client_configuration::certificate_der 필드 — 클라이언트 애플리케이션 인스턴스 인증서입니다(DER, 최대 64 KiB).
• qt_client_configuration::endpoint 필드 — UTF-8로 된 opc.tcp:// 엔드포인트(endpoint) URL입니다. 최대 4096바이트입니다.
• qt_client_configuration::flags 필드 — ::pdcomm_opcua_option_flags 값의 비트 OR입니다.
• qt_client_configuration::mode 필드 — 요청할 ::pdcomm_opcua_security_mode 값입니다.
• qt_client_configuration::policy 필드 — 요청할 ::pdcomm_opcua_policy 값입니다.
• qt_client_configuration::private_key_pem 필드 — 그 인증서의 개인 키입니다(PEM, 최대 64 KiB).
• qt_client_configuration::timeout_ms 필드 — 각 네트워크 교환과 처리 중인 각 요청의 타임아웃(timeout)입니다. 1~300000 ms입니다.
• qt_client_configuration::trusted_server_der 필드 — 신뢰할 서버 인증서입니다(DER, 최대 64 KiB).
• qt_client_configuration::user_name 필드 — UserNameIdentityToken에 쓰는 UTF-8 사용자 이름입니다. anonymous가 false일 때 사용합니다.
• qt_client_configuration::user_secret 필드 — UTF-8 암호입니다. 최대 16 KiB이며 anonymous가 false일 때 사용합니다.
• qt_client_failure 구조체 — qt_client_worker::failed()가 전달하는 실패입니다.
• qt_client_failure::correlation 필드 — 실패한 요청의 상관 ID(correlation)입니다. 워커 실패이면 0입니다.
• qt_client_failure::phase 필드 — "begin", "response", "abort" 또는 "worker"입니다.
• qt_client_failure::status 필드 — 실패의 ::pdcomm_opcua_status 값입니다.
• qt_client_failure::text 필드 — 네이티브 호출 직후 워커 스레드에서 복사한 영문 상세 텍스트입니다.
• qt_client_response 구조체 — qt_client_worker::completed()가 전달하는 응답입니다.
• qt_client_response::correlation 필드 — 애플리케이션이 qt_client_worker::submit()에 전달한 상관 ID(correlation)입니다.
• qt_client_response::metadata 필드 — 응답 메타데이터입니다. 요청 ID, 인코딩 ID와 serviceResult입니다.
• qt_client_response::request_id 필드 — 요청의 네이티브 요청 ID(requestHandle)입니다.
• qt_client_response::value 필드 — 소유된 응답입니다. 클라이언트와 워커보다 오래 유지됩니다. const copy()와 info()는 어느 스레드에서나 호출할 수 있으며, 네이티브 버퍼는 마지막 참조와 함께 해제됩니다.
• qt_client_response_ptr 형식 별칭 — 대기열 시그널(queued signal)로 전달되는 공유된 불변 응답입니다.
• qt_client_stop 열거형 — qt_client_worker::request_stop()이 워커를 끝내는 방식입니다.
• qt_client_stop::abort 열거자 — 다음 확인 시점에 멈추고, 대기 중인 작업을 버리고, 프로토콜 닫기 없이 클라이언트를 해제합니다.
• qt_client_stop::drain 열거자 — 수락된 요청을 모두 완료한 뒤 세션과 채널을 닫습니다.
• qt_client_terminal 구조체 — qt_client_worker::stopped()가 전달하는 최종 보고입니다.
• qt_client_terminal::aborted 필드 — 워커가 그 밖의 방식으로 끝났으면 True입니다. 항상 !orderly입니다.
• qt_client_terminal::accepted 필드 — submit()이 수락한 요청 수입니다.
• qt_client_terminal::completed 필드 — 응답, 또는 "begin"이나 "response" 실패로 끝난 요청 수입니다.
• qt_client_terminal::discarded 필드 — "abort" 실패로 끝난 요청 수입니다.
• qt_client_terminal::orderly 필드 — 드레인(drain)이 CloseSession과 채널 닫기로 끝났으면 True입니다.
• qt_client_terminal::reason 필드 — 워커가 끝난 이유입니다. "drained-and-closed", "aborted", "native-error", "adapter-error" 또는 "restart-rejected"입니다.
• qt_client_worker 클래스 — 네이티브 OPC UA 클라이언트를 소유하는 일회용 QThread입니다.
• qt_client_worker::completed 이벤트 — 검증된 응답이 도착했습니다. 요청은 끝났습니다.
• qt_client_worker::failed 이벤트 — 요청 또는 워커가 실패했습니다. qt_client_failure를 참고합니다.
• qt_client_worker::maximum_commands 필드 — 큐에 있거나 전송 중인, 수락된 요청의 최대 개수입니다.
• qt_client_worker::maximum_queued_bytes 필드 — 요청 하나의 최대 크기이자, 큐에 있고 아직 전송되지 않은 요청 전체를 합한 최대 크기입니다(4 MiB).
• qt_client_worker::operator= 메서드 — 복사 대입을 할 수 없습니다.
• qt_client_worker::pending 이벤트 — 요청이 서버로 전송되었습니다.
• qt_client_worker::qt_client_worker 생성자 — 복사할 수 없습니다.
• qt_client_worker::qt_client_worker 생성자 — 워커를 만듭니다. start()가 연결을 시작합니다.
• qt_client_worker::ready 이벤트 — 세션이 활성화되었고 요청을 보내고 있습니다.
• qt_client_worker::request_stop 메서드 — 워커에 멈추도록 요청합니다. 스레드 안전합니다.
• qt_client_worker::stopped 이벤트 — 워커가 끝났습니다. 항상 한 번의 실행에서 마지막 시그널입니다.
• qt_client_worker::submit 메서드 — UA Binary 서비스 요청 하나를 큐에 넣습니다. 스레드 안전합니다.
• qt_client_worker::~qt_client_worker 메서드 — 중단을 요청하고, 스레드를 기다리고, 자격 증명을 지웁니다.
• require_version 함수 — 로드된 라이브러리가 ABI 0x00000002을 구현하는지 확인합니다.
• response 클래스 — 소유되며 검증된 UA Binary 서비스 응답입니다.
• response::info 메서드 — 응답 메타데이터를 반환합니다.
• response::response 생성자 — 응답 핸들의 소유권을 가져옵니다.
• server 클래스 — 네임스페이스 2에 변수를 두는 메모리 내 OPC UA 서버입니다.
• server::add_variable 메서드 — Objects 폴더 아래에 Variable 노드(node)를 추가합니다.
• server::close 메서드 — 리스너를 닫고 모든 채널을 중단합니다.
• server::create 메서드 — 서버를 만들고 바인딩합니다.
• server::local_address 메서드 — 서버가 수신 대기 중인 소켓 주소를 반환합니다.
• server::poll 메서드 — 블로킹 없이 연결을 수락하고 요청을 한 번 처리합니다.
• server::read_value 메서드 — 인증된 로컬 사용자로서 Value 속성을 읽습니다.
• server::set_value 메서드 — 인증된 로컬 사용자로서 Value 속성(attribute)을 씁니다.
• server_options 함수 — 라이브러리 기본값으로 채운 서버 옵션을 반환합니다.