Vakhshour Developer Mini Guide

At first let me say that i don’t like to write documents ( as other programmer do ), so i will write about some details that you should be awar of. If you want to know more about the Vakhshour please read the code. It’s well commented.

Let’s go straight to the point. As you may read in quick guide, you can send an event using Node object. Here is some details about Node:

class vakhshour.base.Node(host="127.0.0.1", port="8888", secure=False, ssl_key=None, ssl_cert=None, expect_answer=False)

This class represent a network node that runs an instance of Vakhshour daemon.

host

Vakhshour server address.

port

Vakhshour server port to connect.

secure

whether send the event in secure mode or not.

ssl_key

Path to SSL key of the client.

ssl_cert

Path to client certificate of client.

except_answer

Whether except event answer or not.

send_event(name, sender, **kwargs):

Send an event to remote host with the name of name. sender is the name of client that send th event.

every other arguments the you pass to this method by **kwargs will send as the event parameters ans will pass to event handler.

class vakhshour.base.Node.Event

This is the base class the Node class use to send the event. Its is an AMP protocol implementation.