Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConnectionAgent

GameAnvil 서버의 커넥션 노드와 관련된 작업을 담당

접속, 인증 등 기본 세션 관리 기능과 채널 목록 제공

서버 구현에 따라 채널 정보를 제공하거나 사용자 정의 기능을 추가로 제공

커넥터가 초기화 될 때 자동으로 생성되며, 커넥터의 GetConnectionAgent() 함수를 통해 커넥션 에이전트에 접근

기능 요청을 위해 비동기 함수를 호출한 후 동작의 결과를 나중에 전달 받는 방식

리스너와 대리자를 미리 등록해 각 기능 시도 결과를 전달받거나, 기능 요청 시에 대리자를 같이 전달

리스너와 대리자는 여러개 등록 가능

Hierarchy

  • ConnectionAgent

Implements

Index

Methods

Methods

AddListener

AddOnDisconnect

AddOnError

Authenticate

  • GameAnvil 서버에 인증을 요청

    인증에 성공해야 GameAnvil 커넥터의 다른 기능을 사용 가능

    Parameters

    • deviceId: string

      사용자 기기를 식별 할 수 있는 고유 아이디. 같은 사용자의 중복 접속을 체크하는데 사용

    • accountId: string

      사용자 계정을 식별 할 수 있는 고유 아이디

    • password: string

      사용자 계정의 패스워드

    • Optional payload: Payload

      서버로 전달 할 추가 정보

    • Optional callback: (agent: ConnectionAgent, resultCode: ResultCodeAuth, loginedUserInfoList: Array<LoginedUserInfo>, message: string, payload: Payload) => void

      결과를 전달 받아 처리 할 콜백

    Returns void

AuthenticateAsync

  • GameAnvil 서버에 인증을 요청

    인증에 성공해야 GameAnvil 커넥터의 다른 기능을 사용 가능

    Authenticate()의 비동기 버전

    Parameters

    • deviceId: string

      사용자 기기를 식별 할 수 있는 고유 아이디. 같은 사용자의 중복 접속을 체크하는데 사용

    • accountId: string

      사용자 계정을 식별 할 수 있는 고유 아이디

    • password: string

      사용자 계정의 패스워드

    • Optional payload: Payload

      서버로 전달 할 추가 정보

    Returns Promise<AuthenticatePromis>

    인증 요청 결과

Connect

ConnectAsync

  • GameAnvil 서버에 연결

    Connect()의 비동기 버전

    Parameters

    • ipAdress: string

      연결할 서버의 주소 (ws://127.0.0.1:18300/gameanvil)

    Returns Promise<ResultCodeConnect>

    결과 코드

ContainsListener

  • 커넥션 리스너가 등록되었는지 확인

    Parameters

    • Optional listener: IConnectionListener

      확인할 커넥션 리스너. 입력 할 경우 입력한 커넥션 리스너의 등록 여부, 입력하지 않은 경우 하나 이상 등록 여부

    Returns boolean

ContainsOnDisconnect

ContainsOnError

  • 오류 발생시 호출될 콜백이 등록되었는지 확인

    Parameters

    • Optional callback: (agent: ConnectionAgent, errorCode: ErrorCode, command: string) => void

      오류 발생시 호출될 콜백. 입력 할 경우 입력한 콜백의 등록 여부, 입력하지 않은 경우 하나 이상 등록 여부

    Returns boolean

Disconnect

DisconnectAsync

GetAccountId

  • GetAccountId(): string

  • 인증시 사용한 계정 아이디 반환

    Returns string

    인증시 사용한 계정 아이디

GetAllChannelCountInfo

GetAllChannelCountInfoAsync

  • 특정 서비스에 있는 모든 채널의 유저와 방의 개수를 요청

    서버에서 지원할 경우 사용할 수 있음

    AllChannelCountInfo()의 비동기 버전

    Parameters

    • serviceName: string

      채널 정보를 요청할 서비스의 이름

    Returns Promise<GetAllChannelCountInfoPromise>

    채널의 정보를 요청 결과

GetAllChannelInfo

GetAllChannelInfoAsync

  • 특정 서비스에 있는 모든 채널의 유저와 방의 개수를 요청

    서버에서 지원할 경우 사용할 수 있음

    GetAllChannelInfo()의 비동기 버전

    Parameters

    • serviceName: string

      채널 정보를 요청할 서비스의 이름

    Returns Promise<GetAllChannelInfoPromise>

    채널의 정보를 요청 결과

GetChannelCountInfo

GetChannelCountInfoAsync

  • 특정 채널의 유저와 방 개수를 요청

    서버에서 지원할 경우 사용할 수 있음

    GetChannelCountInfo()의 비동기 버전

    Parameters

    • serviceName: string

      채널 정보를 요청할 서비스의 이름

    • channelId: string

      채널 정보를 요청할 체널의 아이디

    Returns Promise<GetChannelCountInfoPromise>

    채널의 정보를 요청 결과

GetChannelInfo

GetChannelInfoAsync

  • 특정 채널의 정보를 요청

    서버에서 지원할 경우 사용할 수 있음

    GetChannelInfo()의 비동기 버전

    Parameters

    • serviceName: string

      채널 정보를 요청할 서비스의 이름

    • channelId: string

      채널 정보를 요청할 체널의 아아디

    Returns Promise<GetChannelInfoPromise>

    채널의 정보를 요청 결과

GetChannelList

GetChannelListAsync

  • 특정 서비스에서 사용 가능한 채널 목록을 요청

    GetChannelList()의 비동기 버전

    Parameters

    • serviceName: string

      채널 정보를 요청할 서비스의 이름

    Returns Promise<GetChannelListPromis>

    채널 목록을 요청 결과

IsConnected

  • IsConnected(): boolean

  • 서버 접속 여부 확인

    Returns boolean

    서버에 접속한 경우 true, 아닌 경우 false

RemoveListener

  • 등록한 커넥션 리스너를 등록 해제

    Parameters

    • Optional listener: IConnectionListener

      해제 할 커넥션 리스너. 입력하지 않을 경우 모든 커넥션 리스너, 입력 할 경우 입력한 커넥션 리스너 등록 해제.

    Returns void

RemoveOnDisconnect

RemoveOnError

  • 등록한 오류 발생시 호출될 콜백을 등록 해제

    Parameters

    • Optional callback: (agent: ConnectionAgent, errorCode: ErrorCode, command: string) => void

      등록한 콜백. 입력 할 경우 입력한 콜백 해제, 입력하지 않은 경우 등록된 모든 콜백 등록 해제

    Returns void

Request

RequestAsync

  • 서버로 패킷 보내고, 응답을 대기

    Request()의 비동기 버전

    Parameters

    • packet: Packet

      서버로 보낼 패킷

    Returns Promise<Packet>

    응답으로 받은 패킷

RequestPb

  • RequestPb<T>(msg: IMessage, callback?: (agent: ConnectionAgent, resMsg: T) => void): void

  • 서버로 프로토 메세지를 보내고, 응답을 대기

    Type parameters

    • T: IMessage

    Parameters

    • msg: IMessage

      서버로 보낼 메세지

    • Optional callback: (agent: ConnectionAgent, resMsg: T) => void

      응답을 받을 경우 호출될 콜백

    Returns void

RequestPbAsync

  • RequestPbAsync<T>(reqMsg: IMessage): Promise<T>

  • 서버로 프로토 버프 메세지를 보내고, 응답을 대기

    RequestPb()의 비동기 버전

    Type parameters

    • T: IMessage

      응답으로 받을 프로토 버프 메세지의 타입

    Parameters

    • reqMsg: IMessage

      서버로 보낼 메세지

    Returns Promise<T>

    응답으로 받은 메세지

Send

SendPb

  • SendPb<T>(reqMsg: IMessage): void

  • 서버로 프로토 버프 메세지를 전송

    Type parameters

    • T: IMessage

    Parameters

    • reqMsg: IMessage

      서버로 보낼 메세지

    Returns void

Generated using TypeDoc