iOS LiveMapClient API

LiveMapServer와 연동을 위한 API 라이브러리. LiveMapServer가 제공하는 기능을 쉽게 사용할 수 있는 API 라이브러리 입니다. LiveMapServer와 연결하여 자신의 서비스를 구축하고 싶은 iOS Application 프로젝트에 서브모듈로 이 프로젝트를 추가해 사용할 수 있습니다.

기능

LiveMapServer와 SSL 소켓으로 암호화된 통신을 합니다.

LiveMapServer로부터 특정한 ID를 부여받을 수 있습니다. ID는 32bit 정수 값이고 접속 할때마다 값이 달라질 수 있습니다.

LiveMapServer로 GPS정보를 업로드할 수 있습니다. LiveMapServer로 GPS 정보를 업로드 하게 되면 LiveMapServer는 해당 GPS로부터 가까운 위치에 다른 클라이언트의 정보를 알려줍니다. LiveMapServer가 알려주는 타 클라이언트들의 정보는 가장 최근에 업데이트된 정보입니다.

LiveMapServer에 접속하고 있는 다른 클라이언트로 메시지를 전송할 수 있고, 다른 클라이언트 가 내 자신으로 송신한 메시지도 수신할 수 있습니다.

iOS LiveMapClient API를 iOS 프로젝트에 Import하기

1. LiveMapClient API를 사용할 xcodeproj가 git을 사용하고 있다면, 해당 프로젝트의 루트 디렉토리에서 submodule로 불러옵니다.

    $ git submodule add https://github.com/interruping/ios_livemap_client_api.git
   

2. git을 사용하고 있지 않다면 git clone으로 해당프로젝트의 루트 디렉토리로 불러옵니다.

    $ git clone https://github.com/interruping/ios_livemap_client_api.git
   

3. Xcode에서 프로젝트의 폴더를 우측클릭하여 'Add Files to [프로젝트 이름]'을 클릭합니다.

4. 이전에 추가된 ios_livemap_client_api 폴더 하위 폴더 src 하위에 있는 소스코드를 전부 선택하고 Add 를 눌러줍니다.

5. 프로젝트의 폴더에 ios_livemap_client_api의 소스코드들이 추가 되었는지 확인합니다.

iOS LiveMapClient API를 업데이트하기

iOS LiveMapClient API를 사용하는 Xcode 프로젝트가 git을 사용하고 있고, ios_livemap_client_api를 submodule로 추가하였다면 ios_livemap_client_api의 부모 프로젝트에서 submodule update git 명령을 실행합니다.

$ git submodule update ios_livemap_client_api

프로젝트가 ios_livemap_client_api를 단독으로 clone 한 경우, ios_livemap_client_api 폴더로 이동하여 Release 브랜치를 pull 리모트 로부터 pull해줍니다.

$ git pull origin Release

iOS LiveMapClient API 예제

SCLiveMapSerivce 객체 생성 및 LiveMapServer와 통신 시작.

#include "SCLiveMapService.h"

@interface XXX... <SCLiveMapServiceDelegate>
//SCLiveMapService 객체 프로퍼티 선언
@property (nonatomic, strong) SCLiveMapService* lmService;
@end

@implementaion XXX...

@synthesize lmService = _lmService;

- (void) someFunc
{
    //SCLiveMapService 객체 생성 & SCLiveMapServiceDelegate 객체 설정.
    self.lmService = [[SCLiveMapService alloc]init];
    self.lmService.delegate = self;
    self.lmService.host = @"라이브맵서버의 주소를 여기에 적으세요.";
    //SCLiveMapService 서비스 비동기 시작.
    [self asyncStart];
}

// [self asyncStart]; 호출 이후, LiveMapServer와 연결이 되고 LiveMapServer로부터 id를 부여받으면 호출됨.
-(void) onServiceReady: (SCLiveMapService*) livemapService createdNode: (SCLiveMapClientNode *) livemapClientNode
{
    //서버로부터 발급받은 id 값 읽기.
    NSInteger idFromeLiveMapServer = livemapClientNode.id;
    
    ....
    // 사용자의 좌표 값 서버로 업데이트
    [self updateUserNode:livemapClientNode];
    // 사용자의 좌표 값과 다른 노드들이 존재하는지 알고 싶은 좌표 업데이트
    [self updateUserNode:livemapClientNode AndViewPointlat:알고싶은 위도 lon:알고싶은 경도]
    
    // 다른 클라이언트에게 메시지 전송
    [self.lmService sendMessageSender:livemapClientNode.id Recver:[다른 클라이언트 id] Msg:@"Hello there."];

}

 //라이브맵 서버로부터 연결에 실패했을 경우 호출됨.
-(void) connectionFailToLiveMapServer: (SCLiveMapService * )livemapService error: (NSError *) error
{
    ...
}

//라이브맵 서버로부터 연결이 끊어졌을 경우 호출됨.
-(void) connectionLostFromLiveMapServer: (SCLiveMapService *) livemapService error: (NSError *)
{

}

//자신의 위치로 또는 알고싶은 좌표로부터 가까이 있는 다른 사용자 노드들의 정보를 서버로부터 받았을 때 호출됨.
-(void) nearNodesFromLiveMapServer: (SCLiveMapService*) livemapService nearNodes: (NSArray<SCLiveMapClientNode*> *) nearNodes
{
    ...
}

//다른 사용자로부터 메시지를 받았을 때 호출됨.
-(void) receivedMessageSender: (NSInteger) senderId Msg: (NSString *) message
{
    ...
}
@end

iOS LiveMapClient API 문서 보기

iOS LiveMapClient API의 문서는 Doxygen으로 자동 생성하도록 작성하였습니다. 프로젝트의 루트 디렉토리에서 doxygen 명령을 실행하여 doc/폴더에 html 과 latex 포멧으로 API문서를 볼 수 있습니다.

$ doxygen

라이센스

이 프로젝트는 Apache License 2.0 라이센스를 따릅니다. 자세한 사항은 LICENSE.txt파일을 참조하세요.