|
| 1 | +# Async Network Engine |
| 2 | + |
| 3 | +Application Http requests made easy to interoperability with Go Lang Backend + Google Protobuf functions! |
| 4 | + |
| 5 | +Supported Cloud Functions: |
| 6 | +- Google Cloud Functions |
| 7 | +- Amazon Web Services Lambdas |
| 8 | + |
| 9 | +Use at your own risk! |
| 10 | + |
| 11 | +# CppSDK |
| 12 | + |
| 13 | +Visit this repo for more info: https://github.com/GameWorkstore/async-network-engine-cpp |
| 14 | + |
| 15 | +# GoLangSDK |
| 16 | + |
| 17 | +Visit this repo for more info: https://github.com/GameWorkstore/async-network-engine-go |
| 18 | + |
| 19 | +# UnitySDK |
| 20 | + |
| 21 | +## How to install |
| 22 | + |
| 23 | +At package.json, add these 3 lines of code: |
| 24 | +```json |
| 25 | +"com.gameworkstore.asyncnetworkengine": "https://github.com/GameWorkstore/async-network-engine.git#0.2.4", |
| 26 | +"com.gameworkstore.googleprotobufunity": "https://github.com/GameWorkstore/google-protobuf-unity.git#3.15.2012", |
| 27 | +"com.gameworkstore.patterns": "https://github.com/GameWorkstore/patterns.git#1.2.0" |
| 28 | +``` |
| 29 | + |
| 30 | +And wait for unity to download and compile the package. |
| 31 | + |
| 32 | +or update package for a newer version, update end of line from 0.2.1 to any released version on Releases. |
| 33 | + |
| 34 | +## Usage Examples |
| 35 | + |
| 36 | +You can find usage examples on Assets/Tests/ folder, for each cloud. |
| 37 | + |
| 38 | +# FAQ |
| 39 | + |
| 40 | +## Uploading to Google Cloud Functions |
| 41 | + |
| 42 | +on upmsync, the job 'upload_gcp' illustrates a possible way to upload your functions into GCP. |
| 43 | +Requires a service account to enable it to upload. |
| 44 | + |
| 45 | +### Uploading to Amazon Web Services |
| 46 | + |
| 47 | +on upmsync.yaml, the job 'upload_aws' illustrates a possible way to upload your functions into AWS. |
| 48 | +Requires a service account to enable it to upload. |
| 49 | +> You need to set the template 'cloudformation_function.yaml' public in your bucket repository to enable AWS::Stack to read from it. |
| 50 | +
|
| 51 | +## GCP Troubleshoot |
| 52 | + |
| 53 | +> My function is returning ErrorProtocol for any input. |
| 54 | +if you don't give access public for your function it might fail |
| 55 | + |
| 56 | +## AWS Troubleshoot |
| 57 | +> CloudFormation is returning errors |
| 58 | +
|
| 59 | +Verify all variables, !Ref and links, you might be forgetting something. CloudFormations is very sensitive to linkage errors. |
| 60 | + |
| 61 | +> My lambda is returning error 500 Internal Server error. |
| 62 | +
|
| 63 | +If you are receiving this and error object is returning null, it might be a bad configuration causing your lambda to not run. |
| 64 | +Verify if you function is running by adding a fmt.Println("test") at main() function to ensure the function is starting. |
| 65 | +Some issues that may prevent the start of function: |
| 66 | +- The functions ins't at correct path when extracted from the zip. |
| 67 | +- The function package name isn't main where main() function is declared. |
| 68 | +- lambda.Start() is never begin called to initialize the function. |
| 69 | +- The function is crashing upon initialization |
| 70 | + |
| 71 | +If the function is working normally, them you might receive error 500 - ErrorInternalServer with AWSError, when specified by the programmer. |
| 72 | + |
| 73 | +# Contributions |
| 74 | + |
| 75 | +If you are using this library and want to submit a change, go ahead! Overall, this project accepts contributions if: |
| 76 | +- Is a bug fix; |
| 77 | +- Or, is a generalization of a well-known issue; |
| 78 | +- Or is performance improvement; |
| 79 | +- Or is an improvement to already supported feature. |
| 80 | + |
| 81 | +Also, you can donate to allow us to drink coffee while we improve it for you! |
0 commit comments