Skip to content

Commit

Permalink
fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
pedrofran12 committed Jan 3, 2021
1 parent 5df5690 commit d8bc65f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# MLD

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/py-mld)](https://pypi.org/project/py-mld/)
[![PyPI](https://img.shields.io/pypi/v/py-mld)](https://pypi.org/project/py-mld/)
[![PyPI - License](https://img.shields.io/pypi/l/py-mld)](https://github.com/pedrofran12/py-mld/blob/master/LICENSE)

This repository stores the implementation of MLDv1 router-side state machines. This can be used to detect multicast interest of directly connected hosts.

The goal of this repository/module is to facilitate maintainability of this MLD implementation since its code is used by other Python projects/modules:
Expand Down Expand Up @@ -28,6 +32,7 @@ The goal of this repository/module is to facilitate maintainability of this MLD
from mld import InterfaceMLD

intf = InterfaceMLD(interface_name="eth0")
intf.enable() # start receiving MLD packets

# get information from a given multicast group
multicast_group_obj = intf.interface_state.get_group_state(group_ip="ff05:10:11:12")
Expand All @@ -45,6 +50,6 @@ multicast_group_obj.add_multicast_routing_entry(notifier)

# when there is a change of multicast interest (for example group ff05::10:11:12 gets interested receivers), the object associated to this object is notified through "notify_membership" method with has_members=True

# if you no longer want to monitor the interest of 224.10.11.12, remove the notifier from the group
# if you no longer want to monitor the interest of ff05::10:11:12, remove the notifier from the group
multicast_group_obj.remove_multicast_routing_entry(notifier)
```
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
long_description=open("README.md", "r").read(),
long_description_content_type="text/markdown",
keywords="MLD MLDv1 Router IPv6 Multicast Interest",
version="1.0",
version="1.0.1",
url="http://github.com/pedrofran12/mld",
author="Pedro Oliveira",
author_email="pedro.francisco.oliveira@tecnico.ulisboa.pt",
Expand Down

0 comments on commit d8bc65f

Please sign in to comment.