giocci_platform

KO | EN

gitlite — search

#hacktoberfest #llm #android #linux #nodejs #windows #cli #kubernetes #vue #security #pytorch #ios #mcp #openai

giocci_platform

(★ 11)

Giocci: a resource-permeating computing platform for wide-area distributed systems

giocci_platform 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Hex version](https://img.shields.io/hexpm/v/giocci.svg "Hex version")](https://hex.pm/packages/giocci)
[![API docs](https://img.shields.io/hexpm/v/giocci.svg?label=hexdocs "API docs")](https://hexdocs.pm/giocci)
[![License](https://img.shields.io/hexpm/l/giocci.svg)](https://github.com/biyooon-ex/giocci_platform/blob/main/LICENSE)

# GiocciPlatform

GiocciPlatform is a resource-permeating computing platform for wide-area distributed systems.

## Overview

This repository contains the GiocciPlatform, which enables distributed code execution across wide-area networks. The platform consists of three main components and an integration test suite:

- **Giocci** - Client library for sending modules and executing functions on remote engines
- **GiocciRelay** - Relay component that manages client/engine registration and routes requests
- **GiocciEngine** - Execution engine that loads modules and executes functions
- **GiocciIntegrationTest** - Integration test suite that verifies end-to-end functionality across all components

All components communicate over [Zenoh](https://zenoh.io/), a pub/sub/query protocol for distributed systems.

## Components

### Giocci

An Elixir library that allows applications to:
- Register with a relay
- Save Elixir modules to remote engines
- Execute functions synchronously or asynchronously

**Installation and usage**: See [apps/giocci/README.md](apps/giocci/README.md)

**Hex package**: [giocci](https://hex.pm/packages/giocci)

### GiocciRelay

A relay service that:
- Manages client and engine registrations
- Stores and distributes modules to engines
- Routes execution requests between clients and engines

**Deployment guide**: See [apps/giocci_relay/README.md](apps/giocci_relay/README.md)

### GiocciEngine

An execution engine that:
- Receives and loads modules dynamically
- Executes functions on behalf of clients
- Returns results synchronously or asynchronously

**Deployment guide**: See [apps/giocci_engine/README.md](apps/giocci_engine/README.md)

### GiocciIntegrationTest

An integration test suite that:
- Verifies end-to-end functionality across all components
- Tests client registration, module distribution, and remote execution
- Validates error handling when components are unavailable
- Includes both synchronous and asynchronous execution scenarios

**Test guide**: See [apps/giocci_integration_test/README.md](apps/giocci_integration_test/README.md)

## Prerequisites

All components require:
- [Zenoh daemon (zenohd)](https://github.com/eclipse-zenoh/zenoh/tree/main/zenohd) running and accessible

## Quick Start

1. **Deploy GiocciRelay**: Follow [apps/giocci_relay/README.md](apps/giocci_relay/README.md)

2. **Deploy GiocciEngine**: Follow [apps/giocci_engine/README.md](apps/giocci_engine/README.md)

3. **Try it out**: Follow the "Running with Docker" section in [apps/giocci/README.md](apps/giocci/README.md) to test the platform

4. **Use in your application**: Once you're familiar with the platform, integrate Giocci into your Elixir application. See the [Installation](apps/giocci/README.md#installation) and [Usage](apps/giocci/README.md#usage) sections in the Giocci README

The [giocci_example](https://github.com/biyooon-ex/giocci_example) repository provides the example code and its instruction for Giocci Client.

## Architecture

### Components

- Client: `apps/giocci`
- Relay: `apps/giocci_relay`
- Engine: `apps/giocci_engine`
- Transport: Zenohex (Zenoh) session

### Communication Flow

This platform communicates over Zenohex (Zenoh) using Query/Reply and Pub/Sub patterns.

### Key Map

- Client registration: `giocci/register/client/{relay_name}`
- Engine registration: `giocci/register/engine/{relay_name}`
- Save module (Client -> Relay): `giocci/save_module/client/{relay_name}`
- Distribute module (Relay -> Engine): `giocci/save_module/relay/{engine_name}`
- Engine inquiry: `giocci/inquiry_engine/client/{relay_name}`
- Sync exec request: `giocci/exec_func/client/{engine_name}`
- Async exec request (Engine subscribes): `giocci/exec_func_async/client/{engine_name}`
- Async exec result (Client subscribes): `giocci/exec_func_async/engine/{client_name}`
- If `key_prefix` is set, it is prepended (e.g., `prefix/giocci/...`).

### Flows

#### 1) Client Registration